DescribeVirtualNodes - Elastic Container Instance - Alibaba Cloud Documentation Center

Queries the details of one or more virtual nodes.

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

eci:DescribeVirtualNodes

get

*VirtualNode

acs:eci:{#regionId}:{#accountId}:virtualnode/{#virtualnodeId}

eci:tag

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
RegionId	string	Yes	The name of the virtual node.	cn-hangzhou
VirtualNodeName	string	No	The IDs of the virtual nodes. You can specify up to 20 IDs. The value must be a JSON-formatted string.	testNode
VirtualNodeIds	string	No	A client token to ensure the idempotence of the request. Generate a value from your client to make sure that the value is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.	["vnd-2ze960zkdqrldeaw**","vnd-3ebzcviqbwt25dsz**"]
ClientToken	string	No	The status of the virtual node. Valid values: Pending Ready Failed	123e4567-e89b-12d3-a456-426655440000
Status	string	No	The ID of the resource group.	Ready
ResourceGroupId	string	No	The token that is used to retrieve the next page of results. You do not need to specify this parameter for the first request. You can obtain the token from the `NextToken` parameter in the response to the previous request. You do not need to set this parameter for the first query. For subsequent queries, you can obtain the token from the response.	rg-uf66jeqopgqa9hdn****
NextToken	string	No	The number of entries to return on each page. Default value: 20. Maximum value: 20. Note The response might contain fewer entries than the specified number.	d78f2dd8-5979-42fe-****-b16db43be5bc
Limit	integer	No	The list of tags that are attached to the virtual node.	20
Tag	array<object>	No	The tags that are attached to the virtual node.
	object	No	The tags that are attached to the virtual node.
Key	string	No	The tag key.	name
Value	string	No	The tag value.	test

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of queried virtual nodes.	1
NextToken	string	The token that is used to start the next query.	d78f2dd8-5979-42fe-****-b16db43be5bc
RequestId	string	The request ID.	9C9B9917-ED22-50D5-ADE6-9FA9D58AD05F
VirtualNodes	array<object>	A collection of virtual node details.
	array<object>	A collection of virtual node details.
Status	string	The status of the virtual node. Possible values: Pending Ready Failed	Ready
CreationTime	string	The time when the virtual node was created. The time is in UTC and follows the RFC 3339 standard.	2021-09-08T15:00:00Z
VpcId	string	The ID of the VPC to which the virtual node belongs.	vpc-1vzjjflab6wvjox****
InternetIp	string	The public IP address of the virtual node.	192.0.XX.XX
Tags	array<object>	The tag information of the virtual node.
	object	The tag information.
Key	string	The tag key.	name
Value	string	The tag value.	test
Events	array<object>	The event information.
	object	The event information.
Type	string	The event type. Possible values: Normal Warning	Normal
LastTimestamp	string	The time when the event ended.	2021-09-08T02:24:52Z
Message	string	The event message.	Successfully
Name	string	The name of the object to which the event belongs.	test
Reason	string	The event name.	Created
Count	integer	The number of events.	1
FirstTimestamp	string	The time when the event started.	2021-09-08T02:24:48Z
VirtualNodeId	string	The ID of the virtual node.	vnd-2ze960zkdqrldeaw****
IntranetIp	string	The internal IP address of the virtual node.	10.19.XX.XX
RegionId	string	The ID of the region to which the virtual node belongs.	cn-hangzhou
VirtualNodeVSwitchId	string	The ID of the vSwitch to which the virtual node belongs.	vsw-2ze23nqzig8inprou****
VirtualNodeSecurityGroupId	string	The ID of the security group to which the virtual node belongs.	sg-2zeeyaaxlkq9sppl****
ResourceGroupId	string	The ID of the resource group to which the virtual node belongs.	rg-uf66jeqopgqa9hdn****
VirtualNodeName	string	The name of the virtual node.	testNode

Examples

Success response

JSON format

{
  "TotalCount": 1,
  "NextToken": "d78f2dd8-5979-42fe-****-b16db43be5bc",
  "RequestId": "9C9B9917-ED22-50D5-ADE6-9FA9D58AD05F",
  "VirtualNodes": [
    {
      "Status": "Ready",
      "CreationTime": "2021-09-08T15:00:00Z",
      "VpcId": "vpc-1vzjjflab6wvjox****",
      "InternetIp": "192.0.XX.XX",
      "Tags": [
        {
          "Key": "name",
          "Value": "test"
        }
      ],
      "Events": [
        {
          "Type": "Normal",
          "LastTimestamp": "2021-09-08T02:24:52Z",
          "Message": "Successfully",
          "Name": "test",
          "Reason": "Created",
          "Count": 1,
          "FirstTimestamp": "2021-09-08T02:24:48Z"
        }
      ],
      "VirtualNodeId": "vnd-2ze960zkdqrldeaw****",
      "IntranetIp": "10.19.XX.XX",
      "RegionId": "cn-hangzhou",
      "VirtualNodeVSwitchId": "vsw-2ze23nqzig8inprou****",
      "VirtualNodeSecurityGroupId": "sg-2zeeyaaxlkq9sppl****",
      "ResourceGroupId": "rg-uf66jeqopgqa9hdn****",
      "VirtualNodeName": "testNode"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	Account.Arrearage	Your account has an outstanding payment.	Your account has an outstanding payment.
400	DryRunOperation	Request validation has been passed with DryRun flag set.	Request validation has been passed with DryRun flag set.
400	InvalidParameter.CPU.Memory	The specified cpu and memory are not allowed
400	InvalidParameter.DuplicatedName	The container group include containers with duplicate names.
400	InvalidParameter.DuplicatedVolumeName	The container group includes volumes with duplicate names.	The container group includes volumes with duplicate names.
400	IncorrectStatus	%s
400	ServiceNotEnabled	%s	The service on which this request depends has not been activated. Please activate and try again.
400	ImageSnapshot.IncorrectStatus	%s	The status of the specified snapshot is invalid.
400	ImageSnapshot.NotSupport	%s	Image caching based on data disk snapshots is not available for all users. If you want to enable this function, contact us.
400	DiskVolume.NotSupport	The disk volume is not supported.	Disk volume does not support your structure. If you want to enable this function, contact us.
400	RamRole.NotSupport	The RAM role is not supported.	The RAM role is not supported.
400	DiskNumber.LimitExceed	The maximum number of disks in an instance is exceeded.	The maximum number of disks in an instance is exceeded.
400	InvalidPaymentMethod.InsufficientBalance	No payment method is specified for your account. We recommend that you add a payment method or add funds to the prepayment balance.	No payment method is specified for your account. We recommend that you add a payment method or add funds to the prepayment balance.
400	DiskVolume.NotInSameZone	The instance to be created and the disk are not in the same zone.	The instance to be created and the disk are not in the same zone.
400	NoPermission	You are not authorized to use the "Product on ECI" feature.
400	HighCpuMemConfigRequired	You need to apply to be added to the whitelist of the specified CPU and memory.	You need to apply to be added to the whitelist of the specified CPU and memory.
400	RecommendEmpty.InstanceTypeFamilyNotMatched	The recommended instance type is unavailable in the current zone. Try again later.
400	LocalDiskAmountNotMatch	The number of local volumes does not match the instance type.
400	Payfor.CreditPayInsufficientBalance	Your payment credit line is insufficient.	Your payment credit line is insufficient.
400	InvalidOperation.KMS.InstanceTypeNotSupport	The specified instance is invalid. Only I/O optimized instances support KMS key.	The specified instance is invalid. Only I/O optimized instances support KMS key.
400	InvalidParameter.Encrypted.KmsNotEnabled	KMS must be enabled for encrypted disks.
400	InvalidParameter.KMS.EncryptedIllegal	After configuring the parameter KmsKeyId, you must enable encryption.	After configuring the parameter KmsKeyId, you must enable encryption.
400	Ipv6AddressNotSupportVsw	IPv6 is not supported in the specified vSwitch.
403	OperationDenied.VswZoneMisMatch	The specified VSwitchId is not in the specified Zone.
403	QuotaExceeded	%s quota exceeded.
403	Zone.NotOnSale	The specified zone is not available for purchase.
403	Forbidden.RiskControl	This operation has been identified as an abnormal operation and cannot be processed.
403	Forbidden.SubUser	The specified action is not available for you.
403	Forbidden.OnlyForInvitedTest	Eci create action is only open to invited users during public beta.
403	OperationDenied.SecurityGroupMisMatch	The specified VSwitchId and SecurityGroupId are not in the same VPC.
403	InvalidVSwitchId.IpNotEnough	The specified VSwitch does not have enough IP addresses.
403	Forbidden.UserNotRealNameAuthentication	This operation is not allowed, because you have not passed the real-name verification.
403	InvalidUser.PassRoleForbidden	The RAM user is not authorized to assume a RAM role.	The RAM user is not authorized to assume a RAM role.
403	NoPermission	The RAM role does not belong to ECS.
403	OperationDenied.NoStock	Sales of this resource are temporarily suspended in the specified zone. We recommend that you use the multi-zone creation function to avoid the risk of insufficient resource. For more information, see https://www.alibabacloud.com/help/document_detail/157290.html
403	InvalidParameter.KMS.KeyId.Forbidden	You are not authorized to access the specified KMSKeyId.	You are not authorized to access the specified KMSKeyId.
403	Forbidden.AccountClosed	The operation is forbidden. Your account has been closed.
403	InvalidOperation.ResourceManagedByCloudProduct	The operation is forbidden. The security group has been managed by another cloud product.
403	Spot.NotMatched	%s. We recommend that you use the create multi-zone function to avoid insufficient inventory. For more information, see https://www.alibabacloud.com/help/document_detail/157290.html
403	SecurityRisk.3DVerification	We have detected a security risk with your default credit or debit card. Please proceed with verification via the link in your email.
403	CreateServiceLinkedRole.Denied	Please make sure the account has ram:CreateServiceLinkedRole permission.	Please make sure the account has ram:CreateServiceLinkedRole permission.
404	ImageSnapshot.NotFound	The specified snapshot does not exist.
404	InvalidDiskId.NotFound	The specified disk does not exist.
404	InvalidParameter.KMS.KeyId.NotFound	The specified KMSKeyId does not exist.	The specified KMSKeyId does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.