API文档

查看VPC资源信息

最近更新时间:2020-07-13 08:56:00

1. 接口描述

接口请求域名: vpc.tencentcloudapi.com 。

本接口(DescribeVpcResourceDashboard)用于查看VPC资源信息。

默认接口请求频率限制:100次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:vpc.ap-shanghai-fsi.tencentcloudapi.com。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeVpcResourceDashboard。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
VpcIds.N Array of String Vpc实例ID,例如:vpc-f1xjkw1b。

3. 输出参数

参数名称 类型 描述
ResourceDashboardSet Array of ResourceDashboard 资源对象列表。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查看VPC资源信息

输入示例

https://vpc.tencentcloudapi.com/?Action=DescribeVpcResourceDashboard
&Version=2017-03-12
&VpcIds.0=vpc-0akbol5v
&<公共请求参数>

输出示例

{
  "Response": {
    "ResourceDashboardSet": [
      {
        "VpcId": "vpc-0akbol5v",
        "SubnetId": "",
        "Classiclink": 0,
        "Nat": 2,
        "Vpngw": 1,
        "Dcg": 1,
        "Pcx": 1,
        "FlowLog": 0,
        "NetworkDetect": 0,
        "NetworkACL": 0,
        "Ip": 157,
        "CVM": 49,
        "LB": 1,
        "CDB": 88,
        "Cmem": 0,
        "CTSDB": 0,
        "MariaDB": 0,
        "SQLServer": 0,
        "Postgres": 0,
        "NAS": 0,
        "Greenplumn": 0,
        "Ckafka": 2,
        "Grocery": 0,
        "HSM": 17,
        "Tcaplus": 0,
        "Cnas": 0,
        "TiDB": 0,
        "Emr": 0,
        "SEAL": 0,
        "CFS": 0,
        "Oracle": 0,
        "ElasticSearch": 0,
        "TBaaS": 0,
        "Itop": 0,
        "DBAudit": 0,
        "CynosDBPostgres": 0,
        "Redis": 0,
        "MongoDB": 0,
        "DCDB": 0,
        "CynosDBMySQL": 0,
        "Subnet": 1,
        "RouteTable": 1
      }
    ],
    "RequestId": "0fee1673-de33-4f0c-9ce4-037cbcf2d7b2"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InvalidParameterValue.Malformed 入参格式不合法。
ResourceNotFound 资源不存在。
目录