有奖征文:轻量对象存储LighthouseCOS用户实践> HOT

1. 接口描述

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

本接口(DescribeCcnAttachedInstances)用于查询云联网实例下已关联的网络实例。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeCcnAttachedInstances。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
Offset Integer 偏移量
示例值:0
Limit Integer 返回数量
示例值:20
Filters.N Array of Filter 过滤条件:
  • ccn-id - String -(过滤条件)CCN实例ID。
  • instance-type - String -(过滤条件)关联实例类型。
  • instance-region - String -(过滤条件)关联实例所属地域。
  • instance-id - String -(过滤条件)关联实例ID。
  • CcnId String 云联网实例ID
    示例值:ccn-245ecr35
    OrderField String 排序字段。支持:CcnId InstanceType InstanceId InstanceName InstanceRegion AttachedTime State。默认值:AttachedTime
    示例值:CcnId
    OrderDirection String 排序方法。升序:ASC,倒序:DESC。默认值:ASC
    示例值:ASC

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合条件的对象数。
    示例值:5
    InstanceSet Array of CcnAttachedInstance 关联实例列表。
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询云联网关联实例列表

    用于查询云联网实例下已关联的网络实例

    输入示例

    POST / HTTP/1.1
    Host: vpc.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeCcnAttachedInstances
    <公共请求参数>
    
    {
        "Filters": [
            {
                "Values": [
                    "vpc-r1ckkpid",
                    "vpc-2u0s99fx",
                    "dcg-98qosdc3",
                    "vpc-3dr1zrr9",
                    "dcg-ni7ps9kb"
                ],
                "Name": "instance-id"
            },
            {
                "Values": [
                    "ccn-gree226l"
                ],
                "Name": "ccn-id"
            }
        ]
    }

    输出示例

    {
        "Response": {
            "InstanceSet": [
                {
                    "CcnId": "ccn-gree226l",
                    "InstanceType": "VPC",
                    "InstanceId": "vpc-2u0s99fx",
                    "InstanceName": "test1",
                    "InstanceRegion": "ap-guangzhou",
                    "InstanceUin": "38059483",
                    "CidrBlock": [
                        "10.0.0.0/16"
                    ],
                    "State": "PENDING",
                    "CcnUin": "100000072292",
                    "InstanceArea": "CHINA_MAINLAND",
                    "AttachedTime": "2021-03-03 16:19:44",
                    "RouteTableId": null,
                    "RouteTableName": null,
                    "Description": ""
                },
                {
                    "CcnId": "ccn-gree226l",
                    "InstanceType": "VPC",
                    "InstanceId": "vpc-r1ckkpid",
                    "InstanceName": "vpc0420",
                    "InstanceRegion": "ap-guangzhou",
                    "InstanceUin": "88419914",
                    "CidrBlock": [
                        "10.33.0.0/16"
                    ],
                    "State": "REJECTED",
                    "CcnUin": "100000072292",
                    "InstanceArea": "CHINA_MAINLAND",
                    "AttachedTime": "2021-03-03 16:19:44",
                    "RouteTableId": null,
                    "RouteTableName": null,
                    "Description": ""
                },
                {
                    "CcnId": "ccn-gree226l",
                    "InstanceType": "VPC",
                    "InstanceId": "vpc-3dr1zrr9",
                    "InstanceName": "10.100.0.0/16",
                    "InstanceRegion": "ap-guangzhou",
                    "InstanceUin": "979137",
                    "CidrBlock": [
                        "10.100.0.0/16"
                    ],
                    "State": "ACTIVE",
                    "CcnUin": "100000072292",
                    "InstanceArea": "CHINA_MAINLAND",
                    "AttachedTime": "2021-03-03 16:19:44",
                    "RouteTableId": null,
                    "RouteTableName": null,
                    "Description": ""
                },
                {
                    "CcnId": "ccn-gree226l",
                    "InstanceType": "DIRECTCONNECT",
                    "InstanceId": "dcg-98qosdc3",
                    "InstanceName": "",
                    "InstanceRegion": "ap-guangzhou",
                    "InstanceUin": "979137",
                    "CidrBlock": [
                        "192.168.0.0/24"
                    ],
                    "State": "ACTIVE",
                    "CcnUin": "100000072292",
                    "InstanceArea": "CHINA_MAINLAND",
                    "AttachedTime": "2021-03-03 16:19:44",
                    "RouteTableId": null,
                    "RouteTableName": null,
                    "Description": ""
                },
                {
                    "CcnId": "ccn-gree226l",
                    "InstanceType": "DIRECTCONNECT",
                    "InstanceId": "dcg-ni7ps9kb",
                    "InstanceName": "",
                    "InstanceRegion": "ap-guangzhou",
                    "InstanceUin": "979137",
                    "CidrBlock": [
                        "192.168.1.0/24"
                    ],
                    "State": "ACTIVE",
                    "CcnUin": "100000072292",
                    "InstanceArea": "CHINA_MAINLAND",
                    "AttachedTime": "2021-03-03 16:19:44",
                    "RouteTableId": null,
                    "RouteTableName": null,
                    "Description": ""
                }
            ],
            "TotalCount": 5,
            "RequestId": "0227fa04-3298-470c-8477-149f309a386a"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InvalidParameter.FilterInvalidKey 指定过滤条件不存在。
    InvalidParameter.FilterNotDict 指定过滤条件不是键值对。
    InvalidParameter.FilterValuesNotList 指定过滤选项值不是列表。
    InvalidParameterValue.LimitExceeded 参数值超出限制。
    InvalidParameterValue.Malformed 入参格式不合法。
    InvalidParameterValue.Range 参数值不在指定范围。
    UnsupportedOperation 操作不支持。
    UnsupportedOperation.AppIdNotFound APPId不存在。