查询CCN列表
最近更新时间: 2024-10-18 10:38:43
1. 接口描述
接口请求域名： vpc.api3.fincloud.tencent.cn。
本接口（DescribeCcns）用于查询云联网（CCN）列表。
默认接口请求频率限制：100次/秒。
接口更新时间：2019-10-16 15:17:19。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeCcns |
| Version | 是 | 否 | String | 公共参数，本接口取值：2017-03-12 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| CcnIds | 否 | 否 | Array of String | CCN实例ID。形如：ccn-f49l6u0z。每次请求的实例的上限为100。参数不支持同时指定CcnIds和Filters。 |
| Filters | 否 | 否 | Array of Filter | 过滤条件，参数不支持同时指定CcnIds和Filters。<br><li>ccn-id - String - （过滤条件）CCN唯一ID，形如：vpc-f49l6u0z。</li><br><li>ccn-name - String - （过滤条件）CCN名称。</li><br><li>ccn-description - String - （过滤条件）CCN描述。</li><br><li>state - String - （过滤条件）实例状态， 'ISOLATED': 隔离中（欠费停服），'AVAILABLE'：运行中。</li><br><li>tag-key - String -是否必填：否- （过滤条件）按照标签键进行过滤。</li><br><li>tag:tag-key - String - 是否必填：否 - （过滤条件）按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。使用请参考示例：查询绑定了标签的CCN列表。</li> |
| Offset | 否 | 否 | Uint64 | 偏移量 |
| Limit | 否 | 否 | Uint64 | 返回数量 |
| OrderField | 否 | 否 | String | 排序字段。支持：CcnId CcnName CreateTime State QosLevel |
| OrderDirection | 否 | 否 | String | 排序方法。顺序：ASC，倒序：DESC。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Uint64 | 此参数对外不可见。 符合条件的对象数。 |
| CcnSet | CCN | 此参数对外不可见。 CCN对象。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | |
| InvalidParameterValue.Malformed | |
| ResourceNotFound | |
| InvalidParameter.Coexist | |
| InvalidParameterValue.LimitExceeded |