查询CCN列表

最近更新时间:2018-10-26 15:01:07

1. 接口描述

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

本接口(DescribeCcns)用于查询云联网(CCN)列表。

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:vpc.ap-shanghai-fsi.tencentcloudapi.com 。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeCcns
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表
CcnIds.N Array of String CCN实例ID。形如:ccn-f49l6u0z。每次请求的实例的上限为100。参数不支持同时指定CcnIds和Filters。
Filters.N Array of Filter 过滤条件,参数不支持同时指定CcnIds和Filters。
  • ccn-id - String - (过滤条件)CCN唯一ID,形如:vpc-f49l6u0z。
  • ccn-name - String - (过滤条件)CCN名称。
  • ccn-description - String - (过滤条件)CCN描述。
  • state - String - (过滤条件)实例状态, 'ISOLATED': 隔离中(欠费停服),'AVAILABLE':运行中。
  • Offset Integer 偏移量
    Limit Integer 返回数量

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合条件的对象数。
    CcnSet Array of CCN CCN对象。
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

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

    输入示例

    https://vpc.tencentcloudapi.com/?Action=DescribeCcns
    &<公共请求参数>
    &CcnIds.0=ccn-8j0phqix
    &CcnIds.1=ccn-gree226l

    输出示例

    {
      "Response": {
        "CcnSet": [
          {
            "CcnDescription": "",
            "CcnId": "ccn-8j0phqix",
            "CcnName": "test",
            "CreateTime": "2018-06-10 16:21:35",
            "InstanceCount": 0,
            "State": "AVAILABLE"
          },
          {
            "CcnDescription": "",
            "CcnId": "ccn-gree226l",
            "CcnName": "test",
            "CreateTime": "2018-06-10 22:04:56",
            "InstanceCount": 1,
            "State": "ISOLATED"
          }
        ],
        "RequestId": "73159790-39b3-48e8-9d61-29e11eed1acd",
        "TotalCount": 2
      }
    }

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

    输入示例

    https://vpc.tencentcloudapi.com/?Action=DescribeCcns
    &<公共请求参数>
    &Filters.0.Name=ccn-name
    &Filters.0.Values.0=test

    输出示例

    {
      "Response": {
        "CcnSet": [
          {
            "CcnDescription": "",
            "CcnId": "ccn-8j0phqix",
            "CcnName": "test",
            "CreateTime": "2018-06-10 16:21:35",
            "InstanceCount": 0,
            "State": "AVAILABLE"
          },
          {
            "CcnDescription": "",
            "CcnId": "ccn-gree226l",
            "CcnName": "test",
            "CreateTime": "2018-06-10 22:04:56",
            "InstanceCount": 1,
            "State": "ISOLATED"
          },
          {
            "CcnDescription": "test description",
            "CcnId": "ccn-nzwnkrgt",
            "CcnName": "test name",
            "CreateTime": "2018-06-18 11:18:30",
            "InstanceCount": 0,
            "State": "AVAILABLE"
          },
          {
            "CcnDescription": "test description",
            "CcnId": "ccn-nrych3fn",
            "CcnName": "test name",
            "CreateTime": "2018-06-18 11:20:58",
            "InstanceCount": 0,
            "State": "AVAILABLE"
          }
        ],
        "RequestId": "d1f17eef-c7c9-4abe-b9ea-843fa5c8db16",
        "TotalCount": 4
      }
    }

    5. 开发者资源

    API Explorer

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InvalidParameter 入参不合法。
    InvalidParameter.Coexist 参数不支持同时指定。
    InvalidParameterValue.LimitExceeded 参数值超出限制。
    InvalidParameterValue.Malformed 入参格式不合法。
    ResourceNotFound 资源不存在。