DescribeInstances-阿里云帮助中心

This operation queries a list of instances based on specified conditions and returns detailed information about the instances.

Operation description

Usage notes

When you call this operation using Alibaba Cloud CLI, request parameter values of different data types must be in specific formats. For more information, see CLI parameter format.

Recommendations

We recommend that you perform a dry run by setting the DryRun parameter to check parameter validity and authorization status.
To query the first page of results, set the MaxResults parameter to limit the number of entries returned. Use the NextToken value in the response to retrieve subsequent pages. For subsequent page queries, set the NextToken parameter to the value from the previous response and set MaxResults to limit the number of entries returned.

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:DescribeInstances

list

Instance

acs:ecs:{#regionId}:{#accountId}:instance/*

Instance

acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

ResourceOwner

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the instance. You can call DescribeRegions to view the latest list of Alibaba Cloud regions.	cn-hangzhou
VpcId	string	No	The ID of the Virtual Private Cloud (VPC).	v-bp67acfmxazb4p****
VSwitchId	string	No	The ID of the vSwitch.	vsw-bp67acfmxazb4p****
ZoneId	string	No	The zone ID.	cn-hangzhou-g
InstanceNetworkType	string	No	The network type of the instance. Valid values: classic: classic network. vpc: Virtual Private Cloud (VPC).	vpc
SecurityGroupId	string	No	The security group to which the instance belongs.	sg-bp67acfmxazb4p****
InstanceIds	string	No	The IDs of instances. Specify multiple instance IDs as a JSON array. You can specify up to 100 IDs. Separate IDs with commas (,).	["i-bp67acfmxazb4p**", "i-bp67acfmxazb4p", … "i-bp67acfmxazb4p**"]
PageNumber	integer	No	Note This parameter will be deprecated. We recommend that you use NextToken and MaxResults to perform paged queries.	1
PageSize	integer	No	Note This parameter will be deprecated. We recommend that you use NextToken and MaxResults to perform paged queries.	10
NextToken	string	No	The pagination token. Set this parameter to the `NextToken` value returned in the last API call.	caeba0bbb2be03f84eb48b699f0a4883
MaxResults	integer	No	The maximum number of entries to return on each page. Maximum value: 100. Default value: If you do not specify this parameter or specify a value less than 10, the default value is 10. If you specify a value greater than 100, the default value is 100.	10
InnerIpAddresses	string	No	The private IP addresses of instances in the classic network. This parameter takes effect only when InstanceNetworkType=classic. Specify multiple IP addresses as a JSON array. You can specify up to 100 IP addresses. Separate IP addresses with commas (,).	["10.1.1.1", "10.1.2.1", … "10.1.10.1"]
PrivateIpAddresses	string	No	The private IP addresses of instances in a VPC. This parameter takes effect only when InstanceNetworkType=vpc. Specify multiple IP addresses as a JSON array. You can specify up to 100 IP addresses. Separate IP addresses with commas (,).	["172.16.1.1", "172.16.2.1", … "172.16.10.1"]
PublicIpAddresses	string	No	The public IP addresses of instances. Specify multiple IP addresses as a JSON array. You can specify up to 100 IP addresses. Separate IP addresses with commas (,).	["42.1.1.", "42.1.2.", … "42.1.10.**"]
EipAddresses	string	No	The Elastic IP addresses of instances. This parameter takes effect only when InstanceNetworkType=vpc. Specify multiple IP addresses as a JSON array. You can specify up to 100 IP addresses. Separate IP addresses with commas (,).	["42.1.1.", "42.1.2.", … "42.1.10.**"]
InstanceChargeType	string	No	The billing method of the instance. Valid values: PostPaid: pay-as-you-go. PrePaid: subscription.	PostPaid
InternetChargeType	string	No	The billing method for public bandwidth. Valid values: PayByBandwidth: pay-by-bandwidth. PayByTraffic: pay-by-data-transfer. Note In pay-by-data-transfer mode, both inbound and outbound peak bandwidth represent upper limits and are not guaranteed service levels. During resource contention, peak bandwidth may be limited. If your business requires guaranteed bandwidth, use pay-by-bandwidth mode.	PayByTraffic
InstanceName	string	No	The name of the instance. You can use the wildcard character * for fuzzy search.	Test
ImageId	string	No	The image ID.	m-bp67acfmxazb4p****
Status	string	No	The status of the instance. Valid values: Pending: The instance is being created. Running: The instance is running. Starting: The instance is starting. Stopping: The instance is stopping. Stopped: The instance is stopped.	Running
LockReason	string	No	The reason why the resource is locked. Valid values: financial: The instance is locked due to overdue payment. security: The instance is locked for security reasons. Recycling: The spot instance is locked and pending release. dedicatedhostfinancial: The ECS instance is locked because the dedicated host has an overdue payment. refunded: The instance is locked due to a refund.	security
Filter.1.Key	string	No	The filter key used to query resources. Set this parameter to `CreationStartTime`. When you set both `Filter.1.Key` and `Filter.1.Value`, you can query resources created after the specified point in time.	CreationStartTime
Filter.2.Key	string	No	The filter key used to query resources. Set this parameter to `CreationEndTime`. When you set both `Filter.2.Key` and `Filter.2.Value`, you can query resources created before the specified point in time.	CreationEndTime
Filter.3.Key	string	No	The filter key used to query resources. Set this parameter to `ExpiredStartTime`. When you set both `Filter.3.Key` and `Filter.3.Value`, you can query resources that expire after the specified point in time.	ExpiredStartTime
Filter.4.Key	string	No	The filter key used to query resources. Set this parameter to `ExpiredEndTime`. When you set both `Filter.4.Key` and `Filter.4.Value`, you can query resources that expire before the specified point in time.	ExpiredEndTime
Filter.1.Value	string	No	The filter value used to query resources. You must also specify the `Filter.1.Key` parameter when you specify this parameter. The value must be in the format `yyyy-MM-ddTHH:mmZ` (UTC+0).	2017-12-05T22:40Z
Filter.2.Value	string	No	The filter value used to query resources. You must also specify the `Filter.2.Key` parameter when you specify this parameter. The value must be in the format `yyyy-MM-ddTHH:mmZ` (UTC+0).	2017-12-06T22:40Z
Filter.3.Value	string	No	The filter value used to query resources. You must also specify the `Filter.3.Key` parameter when you specify this parameter. The value must be in the format `yyyy-MM-ddTHH:mmZ` (UTC+0).	2017-12-07T22:40Z
Filter.4.Value	string	No	The filter value used to query resources. You must also specify the `Filter.4.Key` parameter when you specify this parameter. The value must be in the format `yyyy-MM-ddTHH:mmZ` (UTC+0).	2017-12-08T22:40Z
DeviceAvailable	boolean	No	Note This parameter is in invitational preview and is not supported.	false
IoOptimized	boolean	No	Indicates whether the instance is I/O optimized. Valid values: true: yes. false: no.	true
NeedSaleCycle	boolean	No	Note This parameter is in invitational preview and is not supported.	false
InstanceType	string	No	The instance type.	ecs.g5.large
InstanceTypeFamily	string	No	The instance family.	ecs.g5
KeyPairName	string	No	The name of the SSH key pair used by the instance.	KeyPairNameTest
ResourceGroupId	string	No	The ID of the resource group to which the instance belongs. When you use this parameter to filter resources, the number of resources cannot exceed 1,000. Note Filtering by the default resource group is not supported.	rg-bp67acfmxazb4p****
HpcClusterId	string	No	The ID of the HPC cluster to which the instance belongs.	hpc-bp67acfmxazb4p****
RdmaIpAddresses	string	No	The RDMA IP address of the HPC instance.	10.10.10.102
DryRun	boolean	No	Specifies whether to perform only a dry run for the request. Valid values: true: Only checks the request without querying resources. Checks include AccessKey validity, RAM user permissions, and required parameters. If the check fails, an error is returned. If the check passes, the DryRunOperation error code is returned. false: Sends a normal request. After passing the checks, a 2XX HTTP status code is returned and resources are queried. Default value: false.	false
HttpEndpoint	string	No	Specifies whether to enable access to instance metadata. Valid values: enabled: enabled. disabled: disabled. Default value: enabled. Note For more information about instance metadata, see Overview of instance metadata.	enabled
HttpTokens	string	No	Specifies whether to enforce the use of IMDSv2 when accessing instance metadata. Valid values: optional: does not enforce IMDSv2. required: enforces IMDSv2. After this value is set, instance metadata cannot be accessed in standard mode. Default value: optional. Note For more information about instance metadata access modes, see Instance metadata access modes.	optional
HttpPutResponseHopLimit	integer	No	Note This parameter is not available.	0
Ipv6Address	array	No	The IPv6 addresses assigned to the ENI.
	string	No	The IPv6 address of the ENI. You can specify multiple IPv6 addresses using N. Valid values of N: 1 to 100.	2408:4321:180:1701:94c7:bc38:3bfa:****
Tag	array<object>	No	The list of tags.
	object	No	The list of tags.
key	string	No	The tag key. Note To improve compatibility, we recommend that you use the `Tag.N.Key` parameter instead.	keyTest
Key	string	No	The tag key. Note To improve compatibility, we recommend that you use the `Tag.N.Key` parameter instead.	TestKey
Value	string	No	The tag value of the instance. Valid values of N: 1 to 20.	TestValue
value	string	No	The tag value of the instance. Valid values of N: 1 to 20.	valueTest
AdditionalAttributes	array	No	The list of additional instance attributes.	META_OPTIONS
	string	No	The additional attribute values. Valid values of N: 1 to 5. Valid values: META_OPTIONS: instance metadata. DDH_CLUSTER: dedicated host cluster. NETWORK_PRIMARY_ENI_IP: secondary private IP addresses of the primary ENI. PRIVATE_DNS_OPTIONS: private domain name information. CPU_OPTIONS_TOPOLOGY_TYPE: CPU topology type of the instance. CURRENT_OS_NVME_SUPPORTED: indicates whether the current operating system supports accessing disks over the NVMe protocol. LOGIN_AS_NON_ROOT: indicates whether the instance is configured to allow logon as the ecs-user.	META_OPTIONS

Response elements

Element	Type	Description	Example
	object
NextToken	string	The pagination token returned in this call.	caeba0bbb2be03f84eb48b699f0a4883
PageSize	integer	The number of entries per page that you specified in the request.	10
PageNumber	integer	The page number of the instance list.	1
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	The total number of instances queried. Note When you use the `MaxResults` and `NextToken` parameters for paged queries, the value of the `TotalCount` parameter is meaningless.	1
Instances	object
Instance	array<object>	An array of instances that contains instance information.
	array<object>
CreationTime	string	The time when the instance was created. The time follows the ISO 8601 standard in UTC+0. Format: yyyy-MM-ddTHH:mmZ. For more information, see ISO 8601.	2017-12-10T04:04Z
SerialNumber	string	The serial number of the instance.	51d1353b-22bf-4567-a176-8b3e12e4****
Status	string	The status of the instance.	Running
DeploymentSetId	string	The deployment set ID.	ds-bp67acfmxazb4p****
KeyPairName	string	The key pair name.	testKeyPairName
SaleCycle	string	Note This parameter is deprecated and no longer returns meaningful data.	month
SpotStrategy	string	The bidding policy for pay-as-you-go instances. Valid values: NoSpot: standard pay-as-you-go instance. SpotWithPriceLimit: spot instance with a maximum hourly price. SpotAsPriceGo: spot instance with automatic bidding up to the pay-as-you-go price.	NoSpot
DeviceAvailable	boolean	Indicates whether the instance can have data disks attached. true: Data disks can be attached. false: Data disks cannot be attached.	true
LocalStorageCapacity	integer	The capacity of local storage attached to the instance. Unit: GiB.	1000
Description	string	The description of the instance.	testDescription
SpotDuration	integer	The retention period of the spot instance. Unit: hours. Valid values: 1: Alibaba Cloud guarantees that the instance runs for one hour after creation without being automatically released. After one hour, the system compares your bid price with the market price and checks resource inventory to decide whether to retain or reclaim the instance. 0: Alibaba Cloud does not guarantee that the instance runs for one hour. The system immediately compares your bid price with the market price and checks resource inventory to decide whether to retain or reclaim the instance. Alibaba Cloud sends a notification through an ECS system event five minutes before the instance is reclaimed. Spot instances are billed by second. We recommend that you select an appropriate retention period based on your task execution duration. Note This parameter is returned only when SpotStrategy is set to SpotWithPriceLimit or SpotAsPriceGo.	1
InstanceNetworkType	string	The network type of the instance. Valid values: classic: classic network. vpc: Virtual Private Cloud (VPC).	vpc
InstanceName	string	The name of the instance.	InstanceNameTest
OSNameEn	string	The English name of the operating system of the instance.	CentOS 7.4 64 bit
HpcClusterId	string	The ID of the HPC cluster to which the instance belongs.	hpc-bp67acfmxazb4p****
SpotPriceLimit	number	The maximum hourly price of the instance. You can specify up to three decimal places. This parameter takes effect only when SpotStrategy is set to SpotWithPriceLimit.	0.98
Memory	integer	The memory size. Unit: MiB.	16384
OSName	string	The name of the operating system of the instance.	CentOS 7.4 64 位
DeploymentSetGroupNo	integer	The group position of the ECS instance in the deployment set when the instance is deployed across groups.	1
ImageId	string	The ID of the image used to create the instance.	m-bp67acfmxazb4p****
VlanId	string	The VLAN ID of the instance. Note This parameter will be deprecated. To improve compatibility, use other parameters instead.	10
ClusterId	string	The ID of the cluster to which the instance belongs. Note This parameter will be deprecated. To improve compatibility, use other parameters instead.	c-bp67acfmxazb4p****
ClockOptions	object
PtpStatus	string
GPUSpec	string	The GPU type included in the instance type.	NVIDIA V100
AutoReleaseTime	string	The automatic release time of the pay-as-you-go instance.	2017-12-10T04:04Z
DeletionProtection	boolean	The release protection status of the instance. This parameter specifies whether you can release the instance from the console or by calling the DeleteInstance operation. true: Release protection is enabled. false: Release protection is disabled. Note This parameter applies only to pay-as-you-go instances and protects against manual releases only. It does not protect against system-initiated releases.	false
StoppedMode	string	Specifies whether the instance continues to incur charges after it is stopped. Valid values: KeepCharging: The instance continues to incur charges and retains allocated resources. StopCharging: The instance stops incurring charges. Resources such as vCPUs, memory, and public IP addresses are released. Whether the instance can be restarted depends on resource availability in the region. Not-applicable: The instance does not support the StopCharging mode.	KeepCharging
GPUAmount	integer	The number of GPUs included in the instance type.	4
HostName	string	The hostname of the instance.	testHostName
InstanceId	string	The ID of the instance.	i-bp67acfmxazb4p****
InternetMaxBandwidthOut	integer	The maximum outbound public bandwidth. Unit: Mbit/s.	5
InternetMaxBandwidthIn	integer	The maximum inbound public bandwidth. Unit: Mbit/s.	50
InstanceType	string	The instance type.	ecs.g5.large
InstanceChargeType	string	The billing method of the instance. Valid values: PrePaid: subscription. PostPaid: pay-as-you-go.	PostPaid
RegionId	string	The region ID of the instance.	cn-hangzhou
IoOptimized	boolean	Indicates whether the instance is I/O optimized. true: yes. false: no.	true
StartTime	string	The most recent start time of the instance. The time follows the ISO 8601 standard in UTC+0. Format: yyyy-MM-ddTHH:mmZ. For more information, see ISO 8601.	2017-12-10T04:04Z
Cpu	integer	The number of vCPUs.	8
LocalStorageAmount	integer	The number of local storage devices attached to the instance.	2
ExpiredTime	string	The expiration time. The time follows the ISO 8601 standard in UTC+0. Format: yyyy-MM-ddTHH:mmZ. For more information, see ISO 8601.	2017-12-10T04:04Z
ResourceGroupId	string	The ID of the resource group to which the instance belongs.	rg-bp67acfmxazb4p****
InternetChargeType	string	The network billing type. Valid values: PayByBandwidth: pay-by-bandwidth. PayByTraffic: pay-by-data-transfer.	PayByTraffic
ZoneId	string	The zone to which the instance belongs.	cn-hangzhou-g
Recyclable	boolean	Indicates whether the instance can be recycled.	false
ISP	string	Note This parameter is in invitational preview and is not available.	null
CreditSpecification	string	The performance mode of burstable instances. Valid values: Standard: standard mode. For more information about instance performance, see the Performance constraints section in What are burstable instances?. Unlimited: unlimited mode. For more information about instance performance, see the Unlimited mode section in What are burstable instances?.	Standard
InstanceTypeFamily	string	The instance family.	ecs.g5
OSType	string	The operating system type of the instance. Valid values: windows. linux.	linux
NetworkInterfaces	object
NetworkInterface	array<object>	The collection of ENIs attached to the instance.
	array<object>	The collection of ENIs attached to the instance.
Type	string	The type of the ENI. Valid values: Primary: primary ENI. Secondary: secondary ENI.	Primary
MacAddress	string	The MAC address of the ENI.	00:16:3e:32:b4:**
PrimaryIpAddress	string	The primary private IP address of the ENI.	172.17..*
NetworkInterfaceId	string	The ID of the ENI.	eni-2zeh9atclduxvf1z****
PrivateIpSets	object
PrivateIpSet	array<object>	The collection of PrivateIpSet objects.
	object
PrivateIpAddress	string	The private IP address of the instance.	172.17..
Primary	boolean	Indicates whether the private IP address is the primary private IP address. Valid values: true: yes. false: no.	true
PrivateDnsName	string	The private domain name of the instance. Note A fixed-format private domain name is returned only when `HostnameType` is set to `IpBased` or `InstanceIdBased`.	dnsTestName
Ipv6Sets	object
Ipv6Set	array<object>	The collection of IPv6 addresses assigned to the ENI. This parameter is returned only when the `AdditionalAttributes.N` request parameter is set to `NETWORK_PRIMARY_ENI_IP`.
	object
Ipv6Address	string	The IPv6 address assigned to the ENI.	2408:4321:180:1701:94c7:bc38:3bfa:***
Ipv4PrefixSets	object
Ipv4PrefixSet	array<object>	The collection of IPv4 prefixes assigned to the ENI. This parameter is returned only when the `AdditionalAttributes.N` request parameter is set to `NETWORK_PRIMARY_ENI_IP`.
	object
Ipv4Prefix	string	The IPv4 prefix assigned to the ENI.	192.168../28
Ipv6PrefixSets	object
Ipv6PrefixSet	array<object>	The collection of IPv6 prefixes assigned to the ENI. This parameter is returned only when the `AdditionalAttributes.N` request parameter is set to `NETWORK_PRIMARY_ENI_IP`.
	object
Ipv6Prefix	string	The IPv6 prefix assigned to the ENI.	2001:1111::::/80
OperationLocks	object
LockReason	array<object>	The reason why the instance is locked.
	object
LockMsg	string	The description of why the instance is locked.	The specified instance is locked due to financial reason.
LockReason	string	The lock type. Valid values: financial: The instance is locked due to overdue payment. security: The instance is locked for security reasons. Recycling: The spot instance is locked and pending release. dedicatedhostfinancial: The ECS instance is locked because the dedicated host has an overdue payment. refunded: The instance is locked due to a refund.	Recycling
Tags	object
Tag	array<object>	The collection of tags of the instance.
	object
TagValue	string	The tag value of the instance.	TestValue
TagKey	string	The tag key of the instance.	TestKey
RdmaIpAddress	object
IpAddress	array	The list of RDMA IP addresses of the HPC instance.
	string	The RDMA IP address of the HPC instance.	10.10.10.102
SecurityGroupIds	object
SecurityGroupId	array	The list of security group IDs to which the instance belongs.
	string	The security group ID.	sg-bp67acfmxazb4p****
PublicIpAddress	object
IpAddress	array	The list of public IP addresses of the instance.
	string	The public IP address of the instance.	121.40..
InnerIpAddress	object
IpAddress	array	The list of private IP addresses of instances in the classic network.
	string	The private IP address of the instance in the classic network.	10.170..
VpcAttributes	object	The VPC attributes.
VpcId	string	The ID of the VPC.	vpc-2zeuphj08tt7q3brd****
NatIpAddress	string	The IP address used for network communication between cloud services in the VPC.	172.17..
VSwitchId	string	The ID of the vSwitch.	vsw-2zeh0r1pabwtg6wcs****
PrivateIpAddress	object
IpAddress	array	The list of private IP addresses.
	string	The private IP address.	172.17..
EipAddress	object	The EIP binding information.
IsSupportUnassociate	boolean	Indicates whether the EIP can be disassociated.	true
InternetChargeType	string	The billing method of the EIP. PayByBandwidth: pay-by-bandwidth. PayByTraffic: pay-by-data-transfer.	PayByTraffic
IpAddress	string	The EIP.	42.112..
Bandwidth	integer	The bandwidth limit of the EIP. Unit: Mbit/s.	5
AllocationId	string	The ID of the EIP.	eip-2ze88m67qx5z****
HibernationOptions	object	Note This parameter is in invitational preview and is not available.
Configured	boolean	Note This parameter is in invitational preview and is not available.	false
DedicatedHostAttribute	object	The dedicated host attributes, including DedicatedHostClusterId, DedicatedHostId, and DedicatedHostName.
DedicatedHostId	string	The ID of the dedicated host.	dh-bp67acfmxazb4p****
DedicatedHostName	string	The name of the dedicated host.	testDedicatedHostName
DedicatedHostClusterId	string	The ID of the dedicated host cluster.	dc-bp67acfmxazb4h****
EcsCapacityReservationAttr	object	The capacity reservation parameters of the ECS instance.
CapacityReservationPreference	string	The capacity reservation preference.	cr-bp67acfmxazb4p****
CapacityReservationId	string	The capacity reservation ID.	cr-bp67acfmxazb4p****
DedicatedInstanceAttribute	object	The attributes of the dedicated host instance.
Affinity	string	Indicates whether the dedicated host instance is associated with the dedicated host. Valid values: default: The dedicated host instance is not associated with the dedicated host. After a stopped instance is restarted, it may be placed on another dedicated host in the automatic resource deployment pool. host: The dedicated host instance is associated with the dedicated host. After a stopped instance is restarted, it remains on the original dedicated host.	default
Tenancy	string	Indicates whether the host of the instance is a dedicated host. Valid values: default: The host of the instance is not a dedicated host. host: The host of the instance is a dedicated host.	default
CpuOptions	object	The CPU configuration details.
Numa	string	Note This parameter is deprecated.	null
CoreCount	integer	The number of physical CPU cores.	2
ThreadsPerCore	integer	The number of CPU threads.	2
TopologyType	string	The CPU topology type of the instance. Valid values: HT discrete mode: ContinuousCoreToHTMapping HT continuous mode: DiscreteCoreToHTMapping	DiscreteCoreToHTMapping
EnableVISST	boolean
TurboMode	string
EnableVRDT	boolean
NestedVirtualization	string	Indicates whether nested virtualization is enabled.	enabled
MetadataOptions	object	The metadata options.
HttpEndpoint	string	Specifies whether to enable access to instance metadata. Valid values: enabled: enabled. disabled: disabled.	enabled
HttpPutResponseHopLimit	integer	Note This parameter is not available.	0
HttpTokens	string	Specifies whether to enforce the use of IMDSv2 when accessing instance metadata. Valid values: optional: does not enforce IMDSv2. required: enforces IMDSv2.	optional
InstanceMetadataTags	string
ImageOptions	object	The image-related attribute information.
LoginAsNonRoot	boolean	Indicates whether the instance created from this image supports logon as the ecs-user. Valid values: true: yes. false: no.	false
CurrentOSNVMeSupported	boolean	Indicates whether the current operating system supports accessing disks over the NVMe protocol. Valid values: true: yes. false: no. Note This parameter is returned only when the AdditionalAttributes request parameter includes CURRENT_OS_NVME_SUPPORTED.	true
SpotInterruptionBehavior	string	The interruption mode of the spot instance when the platform initiates an interruption. Valid values: Terminate: release. Stop: stop saving.	Terminate
PrivateDnsNameOptions	object	The private domain name configuration of the instance. For more information about private domain name resolution, see ECS private domain name resolution. Note This parameter is returned only when the `AdditionalAttributes` request parameter includes `PRIVATE_DNS_OPTIONS`.
EnableInstanceIdDnsARecord	boolean	Enables or disables A record resolution from instance ID-based domain names to IPv4 addresses. Valid values: true: enabled. false: disabled. Default value: false.	false
EnableInstanceIdDnsAAAARecord	boolean	Enables or disables AAAA record resolution from instance ID-based domain names to IPv6 addresses. Valid values: true: enabled. false: disabled. Default value: false.	false
EnableIpDnsARecord	boolean	Enables or disables A record resolution from IP-based domain names to IPv4 addresses. Valid values: true: enabled. false: disabled. Default value: false.	true
EnableIpDnsPtrRecord	boolean	Enables or disables PTR record resolution from IPv4 addresses to IP-based domain names. Valid values: true: enabled. false: disabled. Default value: false.	true
HostnameType	string	The hostname type. Valid values: Custom: custom. IpBased: IP-based hostname. InstanceIdBased: instance ID-based hostname. Default value: Custom.	Custom
AdditionalInfo	object	Note This parameter is in invitational preview and is not supported.
EnableHighDensityMode	boolean	Note This parameter is in invitational preview and is not supported.	true
NodeSerialNumber	string
EnableNVS	boolean

Examples

Success response

JSON format

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "PageSize": 10,
  "PageNumber": 1,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": 1,
  "Instances": {
    "Instance": [
      {
        "CreationTime": "2017-12-10T04:04Z",
        "SerialNumber": "51d1353b-22bf-4567-a176-8b3e12e4****",
        "Status": "Running",
        "DeploymentSetId": "ds-bp67acfmxazb4p****",
        "KeyPairName": "testKeyPairName",
        "SaleCycle": "month",
        "SpotStrategy": "NoSpot",
        "DeviceAvailable": true,
        "LocalStorageCapacity": 1000,
        "Description": "testDescription",
        "SpotDuration": 1,
        "InstanceNetworkType": "vpc",
        "InstanceName": "InstanceNameTest",
        "OSNameEn": "CentOS  7.4 64 bit",
        "HpcClusterId": "hpc-bp67acfmxazb4p****",
        "SpotPriceLimit": 0.98,
        "Memory": 16384,
        "OSName": "CentOS  7.4 64 位",
        "DeploymentSetGroupNo": 1,
        "ImageId": "m-bp67acfmxazb4p****",
        "VlanId": "10",
        "ClusterId": "c-bp67acfmxazb4p****",
        "ClockOptions": {
          "PtpStatus": ""
        },
        "GPUSpec": "NVIDIA V100",
        "AutoReleaseTime": "2017-12-10T04:04Z",
        "DeletionProtection": false,
        "StoppedMode": "KeepCharging",
        "GPUAmount": 4,
        "HostName": "testHostName",
        "InstanceId": "i-bp67acfmxazb4p****",
        "InternetMaxBandwidthOut": 5,
        "InternetMaxBandwidthIn": 50,
        "InstanceType": "ecs.g5.large",
        "InstanceChargeType": "PostPaid",
        "RegionId": "cn-hangzhou",
        "IoOptimized": true,
        "StartTime": "2017-12-10T04:04Z",
        "Cpu": 8,
        "LocalStorageAmount": 2,
        "ExpiredTime": "2017-12-10T04:04Z",
        "ResourceGroupId": "rg-bp67acfmxazb4p****",
        "InternetChargeType": "PayByTraffic",
        "ZoneId": "cn-hangzhou-g",
        "Recyclable": false,
        "ISP": "null",
        "CreditSpecification": "Standard",
        "InstanceTypeFamily": "ecs.g5",
        "OSType": "linux",
        "NetworkInterfaces": {
          "NetworkInterface": [
            {
              "Type": "Primary",
              "MacAddress": "00:16:3e:32:b4:**",
              "PrimaryIpAddress": "172.17.**.***",
              "NetworkInterfaceId": "eni-2zeh9atclduxvf1z****",
              "PrivateIpSets": {
                "PrivateIpSet": [
                  {
                    "PrivateIpAddress": "172.17.**.**",
                    "Primary": true,
                    "PrivateDnsName": "dnsTestName"
                  }
                ]
              },
              "Ipv6Sets": {
                "Ipv6Set": [
                  {
                    "Ipv6Address": "2408:4321:180:1701:94c7:bc38:3bfa:***"
                  }
                ]
              },
              "Ipv4PrefixSets": {
                "Ipv4PrefixSet": [
                  {
                    "Ipv4Prefix": "192.168.*.*/28"
                  }
                ]
              },
              "Ipv6PrefixSets": {
                "Ipv6PrefixSet": [
                  {
                    "Ipv6Prefix": "2001:1111:*:*::/80"
                  }
                ]
              }
            }
          ]
        },
        "OperationLocks": {
          "LockReason": [
            {
              "LockMsg": "The specified instance is locked due to financial reason.",
              "LockReason": "Recycling"
            }
          ]
        },
        "Tags": {
          "Tag": [
            {
              "TagValue": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        },
        "RdmaIpAddress": {
          "IpAddress": [
            "10.10.10.102"
          ]
        },
        "SecurityGroupIds": {
          "SecurityGroupId": [
            "sg-bp67acfmxazb4p****"
          ]
        },
        "PublicIpAddress": {
          "IpAddress": [
            "121.40.**.**"
          ]
        },
        "InnerIpAddress": {
          "IpAddress": [
            "10.170.**.**"
          ]
        },
        "VpcAttributes": {
          "VpcId": "vpc-2zeuphj08tt7q3brd****",
          "NatIpAddress": "172.17.**.**",
          "VSwitchId": "vsw-2zeh0r1pabwtg6wcs****",
          "PrivateIpAddress": {
            "IpAddress": [
              "172.17.**.**"
            ]
          }
        },
        "EipAddress": {
          "IsSupportUnassociate": true,
          "InternetChargeType": "PayByTraffic",
          "IpAddress": "42.112.**.**",
          "Bandwidth": 5,
          "AllocationId": "eip-2ze88m67qx5z****"
        },
        "HibernationOptions": {
          "Configured": false
        },
        "DedicatedHostAttribute": {
          "DedicatedHostId": "dh-bp67acfmxazb4p****",
          "DedicatedHostName": "testDedicatedHostName",
          "DedicatedHostClusterId": "dc-bp67acfmxazb4h****"
        },
        "EcsCapacityReservationAttr": {
          "CapacityReservationPreference": "cr-bp67acfmxazb4p****",
          "CapacityReservationId": "cr-bp67acfmxazb4p****"
        },
        "DedicatedInstanceAttribute": {
          "Affinity": "default",
          "Tenancy": "default"
        },
        "CpuOptions": {
          "Numa": "null",
          "CoreCount": 2,
          "ThreadsPerCore": 2,
          "TopologyType": "DiscreteCoreToHTMapping",
          "EnableVISST": false,
          "TurboMode": "",
          "EnableVRDT": false,
          "NestedVirtualization": "enabled"
        },
        "MetadataOptions": {
          "HttpEndpoint": "enabled",
          "HttpPutResponseHopLimit": 0,
          "HttpTokens": "optional",
          "InstanceMetadataTags": ""
        },
        "ImageOptions": {
          "LoginAsNonRoot": false,
          "CurrentOSNVMeSupported": true
        },
        "SpotInterruptionBehavior": "Terminate",
        "PrivateDnsNameOptions": {
          "EnableInstanceIdDnsARecord": false,
          "EnableInstanceIdDnsAAAARecord": false,
          "EnableIpDnsARecord": true,
          "EnableIpDnsPtrRecord": true,
          "HostnameType": "Custom"
        },
        "AdditionalInfo": {
          "EnableHighDensityMode": true,
          "NodeSerialNumber": ""
        },
        "EnableNVS": false
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidTag.Mismatch	The specified Tag.n.Key and Tag.n.Value are not match.	The specified Tag.N.Key and Tag.N.Value parameters do not correspond to each other.
400	InvalidTagCount	The specified tags are beyond the permitted range.	The number of specified tags exceeds the upper limit.
400	InvalidHpcClusterId.NotFound	The specified HpcClusterId is not found.	The specified HpcClusterId parameter does not exist.
400	InvalidHpcClusterId.Creating	The specified HpcClusterId is creating.	The specified HPC cluster is being created.
400	InternalError	The request processing has failed due to some unknown error, exception or failure.
404	InvalidInstanceChargeType.NotFound	The InstanceChargeType does not exist in our records.
404	InvalidInternetChargeType.ValueNotSupported	The specified InternetChargeType is not valid.
404	InvalidLockReason.NotFound	The specified LockReason is not found.	The specified lockout reason does not exist.
404	InvalidFilterKey.NotFound	Invalid filter.%s.	The specified Filter.N.Key is invalid.
404	InvalidFilterValue	Invalid filter.%s.
404	InvalidNetworkType.NotFound	The specified InstanceNetworkType is not found.
404	InvalidStatus.NotFound	The specified Status is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.