全部产品
Search
文档中心

云服务器 ECS:DescribeClassicLinkInstances

更新时间:Sep 12, 2023

调用DescribeClassicLinkInstances查询一台或多台与专有网络VPC建立了连接的经典网络类型实例。

接口说明

调用该接口时,您需要注意:

  • 该接口仅支持经典网络类型实例。
  • 单次最多只能查询100台经典网络类型实例。
  • 参数VpcIdInstanceId不能同时为空。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称

类型

是否必选

示例值

描述

Action String DescribeClassicLinkInstances

系统规定参数。取值:DescribeClassicLinkInstances

RegionId String cn-hangzhou

实例所属的地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。

VpcId String vpc-bp1vwnn14rqpyiczj****

VPC ID。目标VPC必须已开启ClassicLink功能,详情请参见建立ClassicLink连接

InstanceId String i-bp1a5zr3u7nq9cxh****

实例ID。最多指定100台实例ID,并使用半角逗号(,)隔开。

PageNumber String 1

当前页码。起始值:1。

默认值:1 。

PageSize String 10

分页查询时设置的每页行数。取值范围:1~100。

默认值:10。

返回数据

名称

类型

示例值

描述

PageSize Integer 10

分页查询的每页行数。

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

请求ID。

PageNumber Integer 1

分页查询的页码。

TotalCount Integer 2

连接总数。

Links Array of Link

返回经典网络类型实例和VPC连接信息。

Link
VpcId String vpc-test

VPC ID。

InstanceId String i-test

实例ID。

示例

请求示例

https://ecs.aliyuncs.com/?Action=DescribeClassicLinkInstances
&RegionId=cn-hangzhou
&VpcId=vpc-bp1vwnn14rqpyiczj****
&InstanceId=i-bp1a5zr3u7nq9cxh****
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeClassicLinkInstancesResponse> 
    <PageNumber>1</PageNumber>
    <Links>
        <Link>
            <InstanceId>i-bp1a5zr3u7nq9cxh****</InstanceId>
            <VpcId>vpc-bp1vwnn14rqpyiczj****</VpcId>
        </Link>
        <Link>
            <InstanceId>i-bp1a5zr3u7nq9abc****</InstanceId>
            <VpcId>vpc-bp1vwnn14rqpyiczj****</VpcId>
        </Link>
    </Links>
    <TotalCount>2</TotalCount>
    <PageSize>10</PageSize>
    <RequestId>B154D309-F3E1-4AB7-BA94-FEFCA8B89001</RequestId>
</DescribeClassicLinkInstancesResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "PageNumber" : 1,
  "Links" : {
    "Link" : [ {
      "InstanceId" : "i-bp1a5zr3u7nq9cxh****",
      "VpcId" : "vpc-bp1vwnn14rqpyiczj****"
    }, {
      "InstanceId" : "i-bp1a5zr3u7nq9abc****",
      "VpcId" : "vpc-bp1vwnn14rqpyiczj****"
    } ]
  },
  "TotalCount" : 2,
  "PageSize" : 10,
  "RequestId" : "B154D309-F3E1-4AB7-BA94-FEFCA8B89001"
}

错误码

HttpCode

错误码

错误信息

描述

403 InvalidInstanceId.NotFound The InstanceId provided does not exist in our records. 指定的实例不存在,请您检查实例 ID 是否正确。
403 InvalidParameter.ToManyInstanceIds No more than 100 InstanceIds can be specified. 最多只能指定 100 个实例 ID。
403 InvalidParameter.InvalidInstanceIdAndVpcId The parameter InstanceId and VpcId are not allowed to be empty at the same time. 至少指定一个 InstanceId 或 VpcId。
403 InvalidInstanceId.NotBelong The specified instance is not belong to you. 指定的实例不在您账号下。
403 InvalidVpc.NotBelong The specified vpc is not belong to you. 指定的 VPC 不在您的账号下。
403 InvalidParameter.PageNumber The parameter pageNumber is invalid. 指定的 PageNumber 无效。请检查要查询的页码值是否正确。
404 InvalidRegionId.NotFound The specified region does not exist. 指定的 RegionId 不存在,请您检查此产品在该地域是否可用。

访问错误中心查看更多错误码。