All Products
Search
Document Center

Elastic Container Instance:DescribeVirtualNodes

Last Updated:Sep 13, 2024

Queries information about virtual nodes.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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
eci:DescribeVirtualNodesget
  • VirtualNode
    acs:eci:{#regionId}:{#accountId}:virtualnode/{#virtualnodeId}
  • eci:tag
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the virtual nodes.

cn-hangzhou
VirtualNodeNamestringNo

The names of the virtual nodes.

testNode
VirtualNodeIdsstringNo

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

["vnd-2ze960zkdqrldeaw****","vnd-3ebzcviqbwt25dsz****"]
ClientTokenstringNo

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 of requests?

123e4567-e89b-12d3-a456-426655440000
StatusstringNo

The status of the virtual node. Valid values:

  • Pending
  • Ready
  • Failed
Ready
ResourceGroupIdstringNo

The ID of the resource group.

rg-uf66jeqopgqa9hdn****
NextTokenstringNo

The token that determines the start point of 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. From the second request, you can obtain the token from the result returned by the previous request.

d78f2dd8-5979-42fe-****-b16db43be5bc
LimitlongNo

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

Note The number of returned resources is less than or equal to the specified number.
20
Tagarray<object>No

The tags that are bound to the virtual node.

objectNo

The tags that are bound to the virtual node.

KeystringNo

The key of tag N.

name
ValuestringNo

The value of tag N.

test

Response parameters

ParameterTypeDescriptionExample
object
TotalCountinteger

The number of virtual nodes that were queried.

1
NextTokenstring

The token that determines the start point of the next query.

d78f2dd8-5979-42fe-****-b16db43be5bc
RequestIdstring

The ID of the request.

9C9B9917-ED22-50D5-ADE6-9FA9D58AD05F
VirtualNodesarray<object>

The virtual nodes that were queried.

object
Statusstring

The status of the virtual node. Valid values:

  • Pending
  • Ready
  • Failed
Ready
CreationTimestring

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

2021-09-08T15:00:00Z
VpcIdstring

The ID of the VPC to which the virtual node belongs.

vpc-1vzjjflab6wvjox****
InternetIpstring

The public IP address of the virtual node.

192.0.XX.XX
Tagsarray<object>

The tags that are bound to the virtual node.

object

The tags that are bound to the virtual node.

Keystring

The key of the tag.

name
Valuestring

The value of the tag.

test
Eventsarray<object>

The events about the virtual node.

object

The events about the virtual node.

Typestring

The type of the event. Valid values:

  • Normal
  • Warning
Normal
LastTimestampstring

The time when the event ended.

2021-09-08T02:24:52Z
Messagestring

The message of the event.

Successfully
Namestring

The name of the object to which the event belongs.

test
Reasonstring

The name of the event.

Created
Countinteger

The number of events.

1
FirstTimestampstring

The time when the event started.

2021-09-08T02:24:48Z
VirtualNodeIdstring

The ID of the virtual node.

vnd-2ze960zkdqrldeaw****
IntranetIpstring

The private IP address of the virtual node.

10.19.XX.XX
RegionIdstring

The ID of the region in which the virtual node resides.

cn-hangzhou
VirtualNodeVSwitchIdstring

The ID of the vSwitch with which the virtual node is associated.

vsw-2ze23nqzig8inprou****
VirtualNodeSecurityGroupIdstring

The ID of the security group to which the virtual node belongs.

sg-2zeeyaaxlkq9sppl****
ResourceGroupIdstring

The ID of the resource group to which the virtual node belongs.

rg-uf66jeqopgqa9hdn****
VirtualNodeNamestring

The name of the virtual node.

testNode

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
400Account.ArrearageYour account has an outstanding payment.Your account has an outstanding payment.
400DryRunOperationRequest validation has been passed with DryRun flag set.Request validation has been passed with DryRun flag set.
400InvalidParameter.CPU.MemoryThe specified cpu and memory are not allowed-
400InvalidParameter.DuplicatedNameThe container group include containers with duplicate names.-
400InvalidParameter.DuplicatedVolumeNameThe container group includes volumes with duplicate names.The container group includes volumes with duplicate names.
400IncorrectStatus%s-
400ServiceNotEnabled%sYou have not activated the service that is required for processing this request.
400ImageSnapshot.IncorrectStatus%sThe status of the specified snapshot is invalid.
400ImageSnapshot.NotSupport%sImage caching based on data disk snapshots is not available for all users. If you want to enable this function, contact us.
400DiskVolume.NotSupportThe disk volume is not supported.Disk volume does not support your structure. If you want to enable this function, contact us.
400RamRole.NotSupportThe RAM role is not supported.The RAM role is not supported.
400DiskNumber.LimitExceedThe maximum number of disks in an instance is exceeded.The maximum number of disks in an instance is exceeded.
400InvalidPaymentMethod.InsufficientBalanceNo 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.
400DiskVolume.NotInSameZoneThe 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.
400NoPermissionYou are not authorized to use the "Product on ECI" feature.-
400HighCpuMemConfigRequiredYou 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.
400RecommendEmpty.InstanceTypeFamilyNotMatchedThe recommended instance type is unavailable in the current zone. Try again later.-
400LocalDiskAmountNotMatchThe number of local volumes does not match the instance type.-
400Payfor.CreditPayInsufficientBalanceYour payment credit line is insufficient.Your payment credit line is insufficient.
400InvalidOperation.KMS.InstanceTypeNotSupportThe 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.
400InvalidParameter.Encrypted.KmsNotEnabledKMS must be enabled for encrypted disks.-
400InvalidParameter.KMS.EncryptedIllegalAfter configuring the parameter KmsKeyId, you must enable encryption.After configuring the parameter KmsKeyId, you must enable encryption.
400Ipv6AddressNotSupportVswIPv6 is not supported in the specified vSwitch.-
403OperationDenied.VswZoneMisMatchThe specified VSwitchId is not in the specified Zone.-
403QuotaExceeded%s quota exceeded.-
403Zone.NotOnSaleThe specified zone is not available for purchase.-
403Forbidden.RiskControlThis operation has been identified as an abnormal operation and cannot be processed.-
403Forbidden.SubUserThe specified action is not available for you.The specified action is not available for you.
403Forbidden.OnlyForInvitedTestEci create action is only open to invited users during public beta.Eci create action is only open to invited users during public beta.
403OperationDenied.SecurityGroupMisMatchThe specified VSwitchId and SecurityGroupId are not in the same VPC.The specified VSwitchId and SecurityGroupId are not in the same VPC.
403InvalidVSwitchId.IpNotEnoughThe specified VSwitch does not have enough IP addresses.-
403Forbidden.UserNotRealNameAuthenticationThis operation is not allowed, because you have not passed the real-name verification.-
403InvalidUser.PassRoleForbiddenThe RAM user is not authorized to assume a RAM role.The RAM user is not authorized to assume a RAM role.
403NoPermissionThe RAM role does not belong to ECS.-
403OperationDenied.NoStockSales 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-
403InvalidParameter.KMS.KeyId.ForbiddenYou are not authorized to access the specified KMSKeyId.You are not authorized to access the specified KMSKeyId.
403NoPermissionThe RAM role AliyunECIContainerGroupRole does not belong to eci.aliyuncs.com. Please check and try again.-
403Forbidden.AccountClosedThe operation is forbidden. Your account has been closed.-
403InvalidOperation.ResourceManagedByCloudProductThe operation is forbidden. The security group has been managed by another cloud product.-
403Spot.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-
403SecurityRisk.3DVerificationWe have detected a security risk with your default credit or debit card. Please proceed with verification via the link in your email.-
403CreateServiceLinkedRole.DeniedPlease make sure the account has ram:CreateServiceLinkedRole permission.Please make sure the account has ram:CreateServiceLinkedRole permission.
404ImageSnapshot.NotFoundThe specified snapshot does not exist.-
404InvalidDiskId.NotFoundThe specified disk does not exist.-
404InvalidParameter.KMS.KeyId.NotFoundThe specified KMSKeyId does not exist.The specified KMSKeyId does not exist.

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

Change history

Change timeSummary of changesOperation
2023-08-30The Error code has changed. The response structure of the API has changedView Change Details
2023-07-03The Error code has changed. The response structure of the API has changedView Change Details
2021-09-06Add OperationView Change Details