私有网络
视频服务与安全产品捉虫活动邀您参加！> HOT
文档中心>私有网络>API 文档>云联网相关接口>查询CCN列表

查询CCN列表

最近更新时间：2024-03-12 02:03:09

我的收藏

本页目录：

1. 接口描述

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

本接口（DescribeCcns）用于查询云联网（CCN）列表。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeCcns。
Version 是 String 公共参数，本接口取值：2017-03-12。
Region 是 String 公共参数，详见产品支持的 地域列表。
CcnIds.N 否 Array of String CCN实例ID。形如：ccn-f49l6u0z。每次请求的实例的上限为100。参数不支持同时指定CcnIds和Filters。
示例值：ccn-f49l6u0z
Filters.N 否 Array of Filter 过滤条件，参数不支持同时指定CcnIds和Filters。
  • ccn-id - String - （过滤条件）CCN唯一ID，形如：ccn-f49l6u0z。
  • ccn-name - String - （过滤条件）CCN名称。
  • ccn-description - String - （过滤条件）CCN描述。
  • state - String - （过滤条件）实例状态， 'ISOLATED': 隔离中（欠费停服），'AVAILABLE'：运行中。
  • tag-key - String -是否必填：否- （过滤条件）按照标签键进行过滤。
  • tag:tag-key - String - 是否必填：否 - （过滤条件）按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。使用请参考示例：查询绑定了标签的CCN列表。
    		•
    Offset 否 Integer 偏移量
    示例值：0
    Limit 否 Integer 返回数量
    示例值：20
    OrderField 否 String 排序字段。支持：CcnId CcnName CreateTime State QosLevel。默认值: CreateTime
    示例值：CcnName
    OrderDirection 否 String 排序方法。升序：ASC，倒序：DESC。默认值：ASC
    示例值：ASC

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合条件的对象数。
    示例值：10
    CcnSet Array of CCN CCN对象。
    RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 按ID过滤查询CCN列表

    按ID过滤查询CCN列表

    输入示例

    POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCcns
<公共请求参数>

{
    "CcnIds": [
        "ccn-8j0phqix"
    ]
}

    输出示例

    {
    "Response": {
        "TotalCount": 1,
        "RequestId": "73159790-39b3-48e8-9d61-29e11eed1acd",
        "CcnSet": [
            {
                "InstanceCount": 1,
                "TagSet": [
                    {
                        "Value": "env",
                        "Key": "test"
                    }
                ],
                "RoutePriorityFlag": true,
                "CcnId": "ccn-8j0phqix",
                "CcnDescription": "test",
                "State": "AVAILABLE",
                "InstanceChargeType": "POSTPAID",
                "CcnName": "test",
                "QosLevel": "AU",
                "BandwidthLimitType": "INTER_REGION_LIMIT",
                "CreateTime": "2020-09-22 00:00:00",
                "RouteTableFlag": null,
                "RouteTableCount": null
            }
        ]
    }
}

    示例2 按名称过滤查询CCN列表

    按名称过滤查询CCN列表

    输入示例

    POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCcns
<公共请求参数>

{
    "Filters": [
        {
            "Values": [
                "test"
            ],
            "Name": "ccn-name"
        }
    ]
}

    输出示例

    {
    "Response": {
        "TotalCount": 1,
        "RequestId": "73159790-39b3-48e8-9d61-29e11eed1acd",
        "CcnSet": [
            {
                "InstanceCount": 1,
                "TagSet": [
                    {
                        "Value": "env",
                        "Key": "test"
                    }
                ],
                "RoutePriorityFlag": true,
                "CcnId": "ccn-8j0phqix",
                "CcnDescription": "test",
                "State": "AVAILABLE",
                "InstanceChargeType": "POSTPAID",
                "CcnName": "test",
                "QosLevel": "AU",
                "BandwidthLimitType": "INTER_REGION_LIMIT",
                "CreateTime": "2020-09-22 00:00:00",
                "RouteTableFlag": null,
                "RouteTableCount": null
            }
        ]
    }
}

    示例3 查询绑定了标签的CCN列表

    查询绑定了标签键值对（env:test）的ccn。

    输入示例

    POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCcns
<公共请求参数>

{
    "Filters": [
        {
            "Values": [
                "test"
            ],
            "Name": "tag:env"
        }
    ]
}

    输出示例

    {
    "Response": {
        "TotalCount": 1,
        "RequestId": "73159790-39b3-48e8-9d61-29e11eed1acd",
        "CcnSet": [
            {
                "InstanceCount": 1,
                "TagSet": [
                    {
                        "Value": "env",
                        "Key": "test"
                    }
                ],
                "RoutePriorityFlag": true,
                "CcnId": "ccn-8j0phqix",
                "CcnDescription": "test",
                "State": "AVAILABLE",
                "InstanceChargeType": "POSTPAID",
                "CcnName": "test",
                "QosLevel": "AU",
                "BandwidthLimitType": "INTER_REGION_LIMIT",
                "CreateTime": "2020-09-22 00:00:00",
                "RouteTableFlag": null,
                "RouteTableCount": null
            }
        ]
    }
}

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InvalidParameter 参数错误。
    InvalidParameter.Coexist 参数不支持同时指定。
    InvalidParameter.FilterInvalidKey 指定过滤条件不存在。
    InvalidParameter.FilterNotDict 指定过滤条件不是键值对。
    InvalidParameter.FilterValuesNotList 指定过滤选项值不是列表。
    InvalidParameterValue.LimitExceeded 参数值超出限制。
    InvalidParameterValue.Malformed 入参格式不合法。
    InvalidParameterValue.Range 参数值不在指定范围。
    InvalidParameterValue.TooLong 无效参数值。参数值太长。
    ResourceNotFound 资源不存在。
    UnsupportedOperation 操作不支持。
    UnsupportedOperation.ActionNotFound 接口不存在。
    中国站
    文档反馈
    文档活动
    message-icon联系我们
    目录