All Products
Search
Document Center

Elastic Compute Service:DescribeClassicLinkInstances

更新時間:Dec 24, 2024

Queries Elastic Compute Service (ECS) instances that reside in the classic network and have established ClassicLink connections with virtual private clouds (VPCs).

Operation description

Take note of the following items:

  • This operation applies only to instances that reside in the classic network.
  • You can query a maximum of 100 instances that reside in the classic network at a time.
  • At least one of the VpcId and InstanceId parameters must be configured.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ecs:DescribeClassicLinkInstancesget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the instances. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
VpcIdstringNo

The VPC ID. The ClassicLink feature must be enabled for the specified VPC. For more information, see Establish a ClassicLink connection.

vpc-bp1vwnn14rqpyiczj****
InstanceIdstringNo

The instance ID. You can specify a maximum of 100 instance IDs in a single request. Separate the instance IDs with commas (,).

i-bp1a5zr3u7nq9cxh****
PageNumberstringNo

The page number. Pages start from page 1.

Default value: 1.

1
PageSizestringNo

The number of entries per page. Valid values: 1 to 100.

Default value: 10.

10

Response parameters

ParameterTypeDescriptionExample
object
PageSizeinteger

The number of entries per page.

10
RequestIdstring

The request ID.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumberinteger

The page number.

1
TotalCountinteger

The total number of ClassicLink connections.

2
Linkobject
VpcIdstring

The VPC ID.

vpc-test
InstanceIdstring

The instance ID.

i-test

Examples

Sample success responses

JSONformat

{
  "PageSize": 10,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber": 1,
  "TotalCount": 2,
  "Links": {
    "Link": [
      {
        "VpcId": "vpc-test",
        "InstanceId": "i-test"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
403InvalidInstanceId.NotFoundThe InstanceId provided does not exist in our records.The specified instance does not exist. Check whether the instance ID is correct.
403InvalidParameter.ToManyInstanceIdsNo more than 100 InstanceIds can be specified.Up to 100 instance IDs can be specified.
403InvalidParameter.InvalidInstanceIdAndVpcIdThe parameter InstanceId and VpcId are not allowed to be empty at the same time.At least one of the InstanceId and VpcId parameters must be specified.
403InvalidInstanceId.NotBelongThe specified instance is not belong to you.The specified instance does not exist in your account.
403InvalidVpc.NotBelongThe specified vpc is not belong to you.The specified VPC does not belong to your account.
403InvalidParameter.PageNumberThe parameter pageNumber is invalid.The specified PageNumber parameter is invalid.
403InvalidParameter.PageSizeThe parameter pageSize is invalid.-
404InvalidRegionId.NotFoundThe specified region does not exist.The specified RegionId parameter does not exist. Check whether the service is available in the specified region.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-12-20API Description Update. The Error code has changedView Change Details