Queries information about virtual nodes.
Debugging
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.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
eci:DescribeVirtualNodes | get |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
RegionId | string | Yes | The region ID of the virtual nodes. | cn-hangzhou |
VirtualNodeName | string | No | The names of the virtual nodes. | testNode |
VirtualNodeIds | string | No | 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****"] |
ClientToken | string | No | 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 |
Status | string | No | The status of the virtual node. Valid values:
| Ready |
ResourceGroupId | string | No | The ID of the resource group. | rg-uf66jeqopgqa9hdn**** |
NextToken | string | No | 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 |
Limit | long | No | 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 |
Tag | array<object> | No | The tags that are bound to the virtual node. | |
object | No | The tags that are bound to the virtual node. | ||
Key | string | No | The key of tag N. | name |
Value | string | No | The value of tag N. | test |
Response parameters
Examples
Sample success responses
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 | You have not activated the service that is required for processing this request. |
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. | The specified action is not available for you. |
403 | Forbidden.OnlyForInvitedTest | Eci create action is only open to invited users during public beta. | 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. | 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://help.aliyun.com/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 | NoPermission | The RAM role AliyunECIContainerGroupRole does not belong to eci.aliyuncs.com. Please check and try again. | - |
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://help.aliyun.com/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. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2023-08-30 | The Error code has changed. The response structure of the API has changed | View Change Details |
2023-07-03 | The Error code has changed. The response structure of the API has changed | View Change Details |
2021-09-06 | Add Operation | View Change Details |