1. 接口描述
接口请求域名: ecm.tencentcloudapi.com 。
查询私有网络列表
默认接口请求频率限制:20次/秒。
                推荐使用 API Explorer
            
            点击调试
        
                API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
            
        2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 | 
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeVpcs。 | 
| Version | 是 | String | 公共参数,本接口取值:2019-07-19。 | 
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 | 
| VpcIds.N | 否 | Array of String | VPC实例ID。形如:vpc-f49l6u0z。每次请求的实例的上限为100。参数不支持同时指定VpcIds和Filters。 示例值:["vpc-4tw1bxlq"] | 
| Filters.N | 否 | Array of Filter | 过滤条件,参数不支持同时指定VpcIds和Filters。 vpc-name - String - VPC实例名称,只支持单值的模糊查询。 vpc-id - String - VPC实例ID形如:vpc-f49l6u0z。 cidr-block - String - vpc的cidr,只支持单值的模糊查询。 region - String - vpc的region。 tag-key - String -是否必填:否- 按照标签键进行过滤。 tag:tag-key - String - 是否必填:否 - 按照标签键值对进行过滤。 ipv6-cidr-block - String - 是否必填:否 - 按照IPv6 CIDR block进行过滤。 isp-type - String - 是否必填:否 - 按照运营商(如CMCC, CUCC, CTCC)进行过滤。 示例值:[{"Name": "tag-key", "Values": ["env"]}] | 
| Offset | 否 | Integer | 偏移量 示例值:0 | 
| Limit | 否 | Integer | 返回数量 示例值:10 | 
| EcmRegion | 否 | String | 地域 示例值:ap-hefei-ecm | 
| Sort | 否 | String | 排序方式:time时间倒序, default按照网络规划排序 示例值:default | 
3. 输出参数
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| TotalCount | Integer | 符合条件的对象数。 示例值:5 | 
| VpcSet | Array of VpcInfo | 私有网络对象。 | 
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 | 
4. 示例
示例1 查询VPC列表
查询VPC列表
输入示例
https://ecm.tencentcloudapi.com/?Action=DescribeVpcs
&VpcIds.0=vpc-07kqm4uj
&EcmRegion=ap-hangzhou-ecm
&<公共请求参数>输出示例
{
    "Response": {
        "TotalCount": 1,
        "RequestId": "d15a17b7-703b-4757-ae1a-745af315abc4",
        "VpcSet": [
            {
                "EnableDhcp": true,
                "Ipv6ISP": "CMCC",
                "VpcId": "vpc-07kqm4uj",
                "Ipv6CidrBlockSet": [
                    {
                        "IPv6CidrBlock": "240e:95a:3002:1e::/64",
                        "ISPType": "CTCC"
                    }
                ],
                "Description": "",
                "DomainName": "",
                "Ipv6CidrBlock": "",
                "Region": "ap-hangzhou-ecm",
                "DhcpOptionsId": "",
                "InstanceCount": 2,
                "DnsServerSet": [],
                "EnableMulticast": false,
                "VpcName": "Default-VPC",
                "AssistantCidrSet": [],
                "TagSet": null,
                "SubnetCount": 1,
                "CreatedTime": "2020-06-17 12:09:46",
                "CidrBlock": "172.16.0.0/16",
                "IsDefault": true,
                "RegionName": "杭州一区"
            }
        ]
    }
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 | 
|---|---|
| FailedOperation.InternalOperationFailure | 内部操作错误。 | 
| InvalidParameter.Coexist | 参数不支持同时指定。 | 
| InvalidParameter.InvalidDataFormat | 数据格式不正确。 | 
| InvalidParameterValue | 参数取值错误。 | 
| InvalidParameterValue.FilterLimitExceeded | Filter参数数值超过限制。 | 
| InvalidParameterValue.InvalidFilter | 无效过滤器。 | 
| InvalidParameterValue.InvalidPublicParam | 公共参数不合法。 | 
| InvalidParameterValue.InvalidRegion | ecm region不合法。 | 
| InvalidParameterValue.InvalidZoneInstanceCount | 城市或者数量不合法。 | 
| InvalidParameterValue.Malformed | 入参格式不合法。 | 
| UnauthorizedOperation.ForbiddenOperation | 没有权限进行该操作。 |