私有网络查询云联网关联实例列表

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。示例值：[{"Name":"ccn-id","Values":["ccn-nb107zhp"]}]
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）。定位问题时需要提供该次请求的 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": {
        "TotalCount": 1,
        "InstanceSet": [
            {
                "CcnId": "ccn-ch28gexx",
                "InstanceType": "VPC",
                "InstanceId": "vpc-ch28gexx",
                "InstanceName": "instance-name",
                "InstanceRegion": "ap-guangzhou",
                "InstanceUin": "1234611233",
                "CidrBlock": [
                    "10.0.0.0/24"
                ],
                "State": "ACTIVE",
                "AttachedTime": "2020-09-22 00:00:00",
                "CcnUin": "1234611233",
                "InstanceArea": "CHINA_MAINLAND",
                "Description": "desc",
                "RouteTableId": "ccnr-xxxxxxxx",
                "RouteTableName": "ccnr-name"
            }
        ],
        "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。

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

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

查询云联网关联实例列表

本页目录：