DescribeClassicLinkInstances - Elastic Compute Service - Alibaba Cloud Documentation Center

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.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecs:DescribeClassicLinkInstances

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the instances. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
VpcId	string	No	The VPC ID. The ClassicLink feature must be enabled for the specified VPC. For more information, see Establish a ClassicLink connection.	vpc-bp1vwnn14rqpyiczj****
InstanceId	string	No	The instance ID. You can specify a maximum of 100 instance IDs in a single request. Separate the instance IDs with commas (,).	i-bp1a5zr3u7nq9cxh****
PageNumber	string	No	The page number. Pages start from page 1. Default value: 1.	1
PageSize	string	No	The number of entries per page. Valid values: 1 to 100. Default value: 10.	10

Response elements

Element	Type	Description	Example
	object
PageSize	integer	The number of entries per page.	10
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumber	integer	The page number.	1
TotalCount	integer	The total number of ClassicLink connections.	2
Links	object
Link	array<object>	The details of the ClassicLink connections between the instances reside in the classic network and VPCs.
	object
VpcId	string	The VPC ID.	vpc-test
InstanceId	string	The instance ID.	i-test

Examples

Success response

JSON format

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

Error response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
403	InvalidInstanceId.NotFound	The InstanceId provided does not exist in our records.
403	InvalidParameter.ToManyInstanceIds	No more than 100 InstanceIds can be specified.	Up to 100 instance IDs can be specified.
403	InvalidParameter.InvalidInstanceIdAndVpcId	The 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.
403	InvalidInstanceId.NotBelong	The specified instance is not belong to you.
403	InvalidVpc.NotBelong	The specified vpc is not belong to you.
403	InvalidParameter.PageNumber	The parameter pageNumber is invalid.	The specified PageNumber parameter is invalid.
403	InvalidParameter.PageSize	The parameter pageSize is invalid.	The specified paging parameter PageSize is invalid.
404	InvalidRegionId.NotFound	The specified region does not exist.	The specified RegionId parameter does not exist. Check whether the service is available in the specified region.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.