当前位置:主页 > 查看内容

私有网络 查询CCN列表 - API文档

发布时间:2021-09-27 00:00| 位朋友查看

简介:1. 接口描述 接口请求域名: vpc.tencentcloudapi.com 。 本接口(DescribeCcns)用于查询云联网(CCN)列表。 默认接口请求频率限制:100次/秒。 注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例……

1. 接口描述

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

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

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

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

推荐使用 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。
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':运行中。
  • tag-key - String -是否必填:否- (过滤条件)按照标签键进行过滤。
  • tag:tag-key - String - 是否必填:否 - (过滤条件)按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。使用请参考示例:查询绑定了标签的CCN列表。
  • Offset Integer 偏移量
    Limit Integer 返回数量
    OrderField String 排序字段。支持:CcnId CcnName CreateTime State QosLevel
    OrderDirection String 排序方法。顺序:ASC,倒序:DESC

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

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

    输入示例

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

    输出示例

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

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

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

    输入示例

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

    输出示例

    {
      "Response": {
        "CcnSet": [
          {
            "CcnId": "ccn-nzwnkrgt",
            "CcnName": "test name",
            "CcnDescription": "test description",
            "InstanceCount": 0,
            "CreateTime": "2018-06-18 11:18:30",
            "State": "AVAILABLE",
            "TagSet": [
              {
                "Key": "env",
                "Value": "test"
              },
              {
                "Key": "TAG_TEST",
                "Value": "1111"
              }
            ]
          },
          {
            "CcnId": "ccn-nrych3fn",
            "CcnName": "test name",
            "CcnDescription": "test description",
            "InstanceCount": 0,
            "CreateTime": "2018-06-18 11:20:58",
            "State": "AVAILABLE",
            "TagSet": [
              {
                "Key": "TAG_TEST1",
                "Value": "tag1"
              },
              {
                "Key": "env",
                "Value": "test"
              }
            ]
          }
        ],
        "TotalCount": 2,
        "RequestId": "d1f17eef-c7c9-4abe-b9ea-843fa5c8db16"
      }
    }

    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
    • Tencent Cloud SDK 3.0 for Java
    • Tencent Cloud SDK 3.0 for PHP
    • Tencent Cloud SDK 3.0 for Go
    • Tencent Cloud SDK 3.0 for NodeJS
    • Tencent Cloud SDK 3.0 for .NET
    • Tencent Cloud SDK 3.0 for C++
    • Tencent Cloud SDK 3.0 for Ruby

    命令行工具

    • Tencent Cloud CLI 3.0

    6. 错误码

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

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

    本站部分内容转载于网络,版权归原作者所有,转载之目的在于传播更多优秀技术内容,如有侵权请联系QQ/微信:153890879删除,谢谢!
    上一篇:GetResourceTypeTemplate - 资源编排 下一篇:没有了

    推荐图文

    • 周排行
    • 月排行
    • 总排行

    随机推荐