1. 接口描述
接口请求域名： vpc.tencentcloudapi.com 。
本接口（DescribeTenantCcns）用于获取要锁定的云联网实例列表。
该接口一般用来封禁出口限速的云联网实例, 目前联通内部运营系统通过云API调用, 因为出口限速无法按地域间封禁, 只能按更粗的云联网实例粒度封禁, 如果是地域间限速, 一般可以通过更细的限速实例粒度封禁（DescribeCrossBorderCcnRegionBandwidthLimits）
如有需要, 可以封禁任意云联网实例, 可接入到内部运营系统
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeTenantCcns。 |
| Version | 是 | String | 公共参数，本接口取值：2017-03-12。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Filters.N | 否 | Array of Filter | 过滤条件，目前value值个数只支持一个，允许可支持的字段有：ccn-ids 云联网ID数组，值形如：["ccn-12345678"]user-account-id 用户账号ID，值形如：["12345678"]is-security-lock 是否锁定，值形如：["true"] |
| Offset | 否 | Integer | 偏移量，默认0。 示例值：0 |
| Limit | 否 | Integer | 单页返回数据量，可选值0到100之间的整数，默认20。 示例值：1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| CcnSet | Array of CcnInstanceInfo | 云联网（CCN）对象。 注意：此字段可能返回 null，表示取不到有效值。 |
| TotalCount | Integer | 符合条件的对象总数。 示例值：10 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 根据ccn-ids过滤查询
根据ccn-ids过滤查询
输入示例
POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTenantCcns
<公共请求参数>
{
"Filters": [
{
"Values": [
"ccn-gyt67ffz"
],
"Name": "ccn-ids"
}
]
}输出示例
{
"Response": {
"CcnSet": [
{}
],
"TotalCount": 1,
"RequestId": "ff8a76ff-8900-4169-b126-ff59fdb39b6c"
}
}示例2 根据user-account-id过滤查询
根据user-account-id过滤查询
输入示例
POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTenantCcns
<公共请求参数>
{
"Filters": [
{
"Values": [
"1742152960"
],
"Name": "user-account-id"
}
]
}输出示例
{
"Response": {
"CcnSet": [
{},
{},
{}
],
"TotalCount": 3,
"RequestId": "6c72d2a1-b60c-464e-b782-ca6efe7c1dd6"
}
}示例3 根据is-security-lock过滤查询
根据is-security-lock过滤查询
输入示例
POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTenantCcns
<公共请求参数>
{
"Filters": [
{
"Values": [
"false"
],
"Name": "is-security-lock"
}
]
}输出示例
{
"Response": {
"CcnSet": [
{},
{},
{},
{}
],
"TotalCount": 5,
"RequestId": "495efea0-0073-451c-a577-77a23626432c"
}
}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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | 参数错误。 |
| InvalidParameter.FilterInvalidKey | 指定过滤条件不存在。 |
| InvalidParameter.FilterNotDict | 指定过滤条件不是键值对。 |
| InvalidParameter.FilterValuesNotList | 指定过滤选项值不是列表。 |
| InvalidParameterValue.Malformed | 入参格式不合法。 |
| InvalidParameterValue.Range | 参数值不在指定范围。 |
| UnsupportedOperation | 操作不支持。 |
| UnsupportedOperation.UinNotFound | 账号ID不存在。 |
