Queries information about virtual nodes (VNodes).

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeVirtualNodes

The operation that you want to perform. Set the value to DescribeVirtualNodes.

RegionId String Yes cn-hangzhou

The region ID of the virtual nodes.

ResourceGroupId String Yes rg-uf66jeqopgqa9hdn****

The ID of the resource group.

SecurityGroupId String Yes sg-2ze81zoc3yl7a3we****

The ID of the security group.

VirtualNodeName String Yes testNode

The name of the virtual node.

VSwitchId String Yes vsw-2ze23nqzig8inprou****

The ID of the vSwitch.

ZoneId String No cn-hangzhou-b

The ID of the zone.

VirtualNodeIds String No ["vnd-2ze960zkdqrldeaw****","vnd-3ebzcviqbwt25dsz****"]

The IDs of the virtual nodes. You can specify up to 20 IDs. Each ID must be a string in JSON format.

ClientToken String No 123e4567-e89b-12d3-a456-426655440000

The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotency.

Status String No Ready

The status of the virtual node. Valid values:

  • Pending
  • Ready
  • Failed
NextToken String No d78f2dd8-5979-42fe-****-b16db43be5bc

The token that is used for the next query. If this parameter is empty, all results have been returned.

You do not need to specify this parameter in the first request. You can obtain the token from the result returned by the previous request.

Limit Long No 20

The maximum number of resources that are allowed to return for this request. Default value: 20. Maximum value: 20.

Note The number of resources to be returned is no greater than this parameter value.
Tag.N.Key String No name

The key of tag N.

Tag.N.Value String No test

The value of tag N.

Response parameters

Parameter Type Example Description
NextToken String d78f2dd8-5979-42fe-****-b16db43be5bc

The token that was returned for the next query.

RequestId String 9C9B9917-ED22-50D5-ADE6-9FA9D58AD05F

The ID of the request.

TotalCount Integer 1

The number of virtual nodes that were queried.

VirtualNodes Array of VirtualNode

The virtual nodes that were queried.

ClusterId String c9af4f6c1563c4cd4bda887bfeb72****

The ID of the Kubernetes cluster.

Cpu Float 2.0

The number of vCPUs. This parameter is unavailable.

CreationTime String 2021-09-08T15:00:00Z

The time when the virtual node was created. The time follows the RFC 3339 standard and is displayed in UTC.

EniInstanceId String eni-bp14rzqi6fd8satm****

The ID of the elastic network interface (ENI). This parameter is unavailable.

Events Array of Event

An array of the events.

Count Integer 1

The number of events.

FirstTimestamp String 2021-09-08T02:24:48Z

The time when the event started.

LastTimestamp String 2021-09-08T02:24:52Z

The time when the event ended.

Message String Successfully

The message of the event.

Name String test

The name of the object to which the event belongs.

Reason String Created

The name of the event.

Type String Normal

The type of the event. Valid values:

  • Normal
  • Warning
InternetIp String 192.0.XX.XX

The public IP address.

IntranetIp String 10.19.XX.XX

The internal IP address.

Memory Float 4.0

The memory size. This parameter is unavailable.

RamRoleName String testECI

The name of the Resource Access Management (RAM) role. This parameter is unavailable.

RegionId String cn-hangzhou

The region ID of the virtual node.

ResourceGroupId String rg-uf66jeqopgqa9hdn****

The ID of the resource group.

SecurityGroupId String sg-2ze81zoc3yl7a3we****

The ID of the security group.

Status String Ready

The status of the virtual node. Valid values:

  • Pending
  • Ready
  • Failed
Tags Array of Label

An array of tags.

Key String name

The tag key of the virtual node.

Value String test

The tag value of the virtual node.

VSwitchId String vsw-2ze23nqzig8inprou****

The ID of the vSwitch.

VirtualNodeId String vnd-2ze960zkdqrldeaw****

The ID of the virtual node.

VirtualNodeName String testNode

The name of the virtual node.

VpcId String vpc-1vzjjflab6wvjox****

The ID of the virtual private cloud (VPC).

ZoneId String cn-hangzhou-b

The ID of the zone.

Examples

Sample requests

https://eci.aliyuncs.com/?Action=DescribeVirtualNodes
&RegionId=cn-hangzhou
&ResourceGroupId=rg-uf66jeqopgqa9hdn****
&SecurityGroupId=sg-2ze81zoc3yl7a3we****
&VirtualNodeName=testNode
&VSwitchId=vsw-2ze23nqzig8inprou****
&<Common request parameters>

Sample success responses

XML format

<DescribeVirtualNodesResponse>
      <TotalCount>1</TotalCount>
      <RequestId>9C9B9917-ED22-50D5-ADE6-9FA9D58AD05F</RequestId>
      <NextToken>d78f2dd8-5979-42fe-****-b16db43be5bc</NextToken>
      <VirtualNodes>
            <Status>Ready</Status>
            <ZoneId>cn-hangzhou-b</ZoneId>
            <ResourceGroupId>rg-uf66jeqopgqa9hdn****</ResourceGroupId>
            <ClusterId>c9af4f6c1563c4cd4bda887bfeb72****</ClusterId>
            <VSwitchId>vsw-2ze23nqzig8inprou****</VSwitchId>
            <SecurityGroupId>sg-2ze81zoc3yl7a3we****</SecurityGroupId>
            <IntranetIp>10.19.XX.XX</IntranetIp>
            <InternetIp>192.0.XX.XX</InternetIp>
            <VirtualNodeId>vnd-2ze960zkdqrldeaw****</VirtualNodeId>
            <EniInstanceId>eni-bp14rzqi6fd8satm****</EniInstanceId>
            <CreationTime>2021-09-08T15:00:00Z</CreationTime>
            <RegionId>cn-hangzhou</RegionId>
            <VirtualNodeName>testNode</VirtualNodeName>
            <Tags>
                  <Value>test</Value>
                  <Key>name</Key>
            </Tags>
      </VirtualNodes>
</DescribeVirtualNodesResponse>

JSON format

{
    "TotalCount": "1",
    "RequestId": "9C9B9917-ED22-50D5-ADE6-9FA9D58AD05F",
    "NextToken": "d78f2dd8-5979-42fe-****-b16db43be5bc",
    "VirtualNodes": [
        {
            "Status": "Ready",
            "ZoneId": "cn-hangzhou-b",
            "ResourceGroupId": "rg-uf66jeqopgqa9hdn****",
            "ClusterId": "c9af4f6c1563c4cd4bda887bfeb72****",
            "VSwitchId": "vsw-2ze23nqzig8inprou****",
            "SecurityGroupId": "sg-2ze81zoc3yl7a3we****",
            "IntranetIp": "10.19.XX.XX",
            "InternetIp": "192.0.XX.XX",
            "VirtualNodeId": "vnd-2ze960zkdqrldeaw****",
            "EniInstanceId": "eni-bp14rzqi6fd8satm****",
            "CreationTime": "2021-09-08T15:00:00Z",
            "RegionId": "cn-hangzhou",
            "VirtualNodeName": "testNode",
            "Events": [],
            "Tags": [
                {
                    "Value": "test",
                    "Key": "name"
                }
            ]
        }
    ]
}

Error codes

HTTP status code Error code Error message Description
400 Account.Arrearage Your account has an outstanding payment. The error message returned because you have an overdue payment in your account.
400 DryRunOperation Request validation has been passed with DryRun flag set. The error message returned because the request is determined as valid in the dry run.
400 InvalidParameter.CPU.Memory The specified cpu and memory are not allowed The error message returned because the vCPU and memory specifications are invalid.
400 InvalidParameter.DuplicatedName The container group include containers with duplicate names. The error message returned because the container group contains containers with duplicate names.
400 InvalidParameter.DuplicatedVolumeName The container group includes volumes with duplicate names. The error message returned because the container group contains volumes with duplicate names.
400 IncorrectStatus %s The error message returned because the status of the specified elastic container instance is invalid.
400 ServiceNotEnabled %s The error message returned because the service that is required to call the operation is not activated. Activate the service and try again later.
400 ImageSnapshot.IncorrectStatus %s The error message returned because the status of the image cache snapshot is invalid.
400 ImageSnapshot.NotSupport %s The error message returned because the image cache feature based on data disk snapshots is not available to all users. If you need to use this feature, contact Alibaba Cloud technical support personnel.
400 DiskVolume.NotSupport The disk volume is not supported. The error message returned because the disk cannot be used as a volume. If you want to use the disk, contact Alibaba Cloud technical support personnel.
400 RamRole.NotSupport The RAM role is not supported. The error message returned because the specified Resource Access Management (RAM) role is not supported.
400 DiskNumber.LimitExceed The maximum number of disks in an instance is exceeded. The error message returned because the number of disks attached to the container group has reached the upper limit.
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. The error message returned because your Alibaba Cloud account does not have a valid payment method. Specify a valid payment method or top up the balance.
400 DiskVolume.NotInSameZone The instance to be created and the disk are not in the same zone. The error message returned because the container group that you want to create is not in the same zone as the disk.
400 NoPermission You are not authorized to use the "Product on ECI" feature. The error message returned because you are not authorized to use Alibaba Cloud services with Elastic Container Instance.
400 HighCpuMemConfigRequired You need to apply to be added to the whitelist of the specified CPU and memory. The error message returned because your account is not authorized to use the specified CPU and memory resources.
400 RecommendEmpty.InstanceTypeFamilyNotMatched The recommended instance type is unavailable in the current zone. Try again later. The error message returned because no instance types meet the requirements in the current zone. Try again later or create the instance in other zones.
400 LocalDiskAmountNotMatch The number of local volumes does not match the instance type. The error message returned because the number of local disks does not match the instance type.
400 Payfor.CreditPayInsufficientBalance Your payment credit line is insufficient. The error message returned because the balance in your credit card is insufficient.
400 InvalidOperation.KMS.InstanceTypeNotSupport The specified instance is invalid. Only I/O optimized instances support KMS key. The error message returned because the specified instance is not supported. You can set Key Management Service (KMS) keys only for I/O optimized instances.
400 InvalidParameter.Encrypted.KmsNotEnabled KMS must be enabled for encrypted disks. The error message returned because KMS is not activated. You must activate KMS to encrypt disks.
400 InvalidParameter.KMS.EncryptedIllegal After configuring the parameter KmsKeyId, you must enable encryption. The error message returned because the encryption feature is not enabled after a KMS key ID is specified.
400 Ipv6AddressNotSupportVsw IPv6 is not supported in the specified vSwitch. The error message returned because no IPv6 address is activated for the vSwitch.
403 OperationDenied.VswZoneMisMatch The specified VSwitchId is not in the specified Zone. The error message returned because the specified vSwitch is not deployed in the current zone.
403 QuotaExceeded %s quota exceeded. The error message returned because the maximum number of elastic container instances is reached.
403 Zone.NotOnSale The specified zone is not available for purchase. The error message returned because the specified zone is unavailable or because the vSwitches in the specified VPC are unavailable in the current zone. Specify another zone.
403 Forbidden.RiskControl This operation has been identified as an abnormal operation and cannot be processed. The error message returned because the operation is determined as abnormal and cannot be performed.
403 Forbidden.SubUser The specified action is not available for you. The error message returned because you do not have the permissions to perform the operation.
403 Forbidden.OnlyForInvitedTest Eci create action is only open to invited users during public beta. The error message returned because Elastic Container Instance is available only to invited users during the public preview period.
403 OperationDenied.SecurityGroupMisMatch The specified VSwitchId and SecurityGroupId are not in the same VPC. The error message returned because the specified vSwitch and security group are not deployed in the same VPC.
403 InvalidVSwitchId.IpNotEnough The specified VSwitch does not have enough IP addresses. The error message returned because the vSwitch does not have sufficient IP addresses.
403 Forbidden.UserNotRealNameAuthentication This operation is not allowed, because you have not passed the real-name verification. The error message returned because you have not completed real-name verification and the operation is not allowed.
403 InvalidUser.PassRoleForbidden The RAM user is not authorized to assume a RAM role. The error message returned because the RAM user is not authorized to assume a RAM role.
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://help.aliyun.com/document_detail/157290.html The error message returned because available resources are insufficient. Try other regions, zones or instance types. To ensure that available resources are sufficient, we recommend that you specify multiple zones and instance types. For more information, visit https://www.alibabacloud.com/help/doc-detail/157290.html.
403 InvalidParameter.KMS.KeyId.Forbidden You are not authorized to access the specified KMSKeyId. The error message returned because you are not authorized to access the specified KMS key ID.
403 NoPermission The RAM role AliyunECIContainerGroupRole does not belong to eci.aliyuncs.com. Please check and try again. The error message returned because the AliyunECIContainerGroupRole RAM role does not belong to eci.aliyuncs.com. Check and try again.
403 Forbidden.AccountClosed The operation is forbidden. Your account has been closed. The error message returned because the Alibaba Cloud account is unregistered and your operations are not allowed.
403 InvalidOperation.ResourceManagedByCloudProduct The operation is forbidden. The security group has been managed by another cloud product. The error message returned because the security group is managed by another Alibaba Cloud service and is not allowed to operate.
403 Spot.NotMatched %s. We recommend that you use the create multi-zone function to avoid insufficient inventory. For more information, see https://help.aliyun.com/document_detail/157290.html %s. The error message returned because the inventory of the resource is insufficient. We recommend that you specify multiple zones and instance types to avoid insufficient resources. For more information, visit https://www.alibabacloud.com/help/doc-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. The error message returned because risks are detected in your default credit card or debit card. Click the URL in the email for verification.
403 CreateServiceLinkedRole.Denied Please make sure the account has ram:CreateServiceLinkedRole permission. The error message returned because you do not have the ram:CreateServiceLinkedRole permission.
404 ImageSnapshot.NotFound The specified snapshot does not exist. The error message returned because the specified image cache snapshot does not exist.
404 InvalidDiskId.NotFound The specified disk does not exist. The error message returned because the specified disk does not exist.
404 InvalidParameter.KMS.KeyId.NotFound The specified KMSKeyId does not exist. The error message returned because the specified KMSKeyId parameter does not exist.

For a list of error codes, visit the API Error Center.