查询黑石私有网络关联资源

最近更新时间:2019-07-24 15:03:04

1. 接口描述

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

查询黑石私有网络关联资源

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeVpcResource
Version String 公共参数,本接口取值:2018-06-25
Region String 公共参数,本接口不需要传递此参数。
VpcIds.N Array of String 私有网络实例ID
Filters.N Array of Filter 过滤条件,参数不支持同时指定SubnetIds和Filters。
vpc-id - String - (过滤条件)私有网络实例ID,形如:vpc-f49l6u0z。
vpc-name - String - (过滤条件)私有网络名称。
zone - String - (过滤条件)可用区。
state - String - (过滤条件)VPC状态。
Offset Integer 偏移量
Limit Integer 返回数量

3. 输出参数

参数名称 类型 描述
VpcResourceSet Array of VpcResource VPC数据
TotalCount Integer VPC个数
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询账户下私有网络的资源占用情况

输入示例

https://bmvpc.tencentcloudapi.com/?Action=DescribeVpcResource
&<公共请求参数>

输出示例

{
  "Response": {
    "VpcResourceSet": [
      {
        "VpcId": "vpc-ox7p0l9u",
        "VpcName": "autocreate_20180320",
        "CidrBlock": "10.104.0.0/16",
        "SubnetNum": 10,
        "NatNum": 0,
        "State": "available",
        "MonitorFlag": false,
        "CpmNum": 6,
        "LeaveIpNum": 65515,
        "LbNum": 0,
        "TrafficMirrorNum": 0,
        "EipNum": 0,
        "PlgwNum": 0,
        "PlvpNum": 0,
        "SslVpnGwNum": 0,
        "VpcPeerNum": 0,
        "IpsecVpnGwNum": 0,
        "CreateTime": "2018-03-20 11:40:49",
        "Zone": "ap-guangzhou-bls-1"
      },
      {
        "VpcId": "vpc-jvxdy07y",
        "VpcName": "test-勿用-假vpc",
        "CidrBlock": "172.16.0.0/16",
        "SubnetNum": 0,
        "NatNum": 0,
        "State": "available",
        "MonitorFlag": false,
        "CpmNum": 0,
        "LeaveIpNum": 65533,
        "LbNum": 0,
        "TrafficMirrorNum": 0,
        "EipNum": 0,
        "PlgwNum": 0,
        "PlvpNum": 0,
        "SslVpnGwNum": 0,
        "VpcPeerNum": 0,
        "IpsecVpnGwNum": 0,
        "CreateTime": "2018-06-12 10:13:17",
        "Zone": "ap-guangzhou-bls-1"
      },
      {
        "VpcId": "vpc-32olgueo",
        "VpcName": "spain",
        "CidrBlock": "10.233.0.0/16",
        "SubnetNum": 0,
        "NatNum": 0,
        "State": "failed",
        "MonitorFlag": true,
        "CpmNum": 0,
        "LeaveIpNum": 65533,
        "LbNum": 0,
        "TrafficMirrorNum": 0,
        "EipNum": 0,
        "PlgwNum": 0,
        "PlvpNum": 0,
        "SslVpnGwNum": 0,
        "VpcPeerNum": 0,
        "IpsecVpnGwNum": 0,
        "CreateTime": "2018-11-20 15:42:36",
        "Zone": "ap-guangzhou-bls-1"
      }
    ],
    "TotalCount": 3,
    "RequestId": "aeb9eb8b-68c7-4ef1-89ae-a99c4c76783a"
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败
InternalError 内部错误
InvalidParameter 参数错误