文档

DescribeVirtualNodes - 批量查询虚拟节点信息

更新时间:

调用DescribeVirtualNodes批量查询虚拟节点的详细信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
eci:DescribeVirtualNodesRead
  • VirtualNode
    acs:eci:{#regionId}:{#accountId}:virtualnode/{#virtualnodeId}
  • eci:tag

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。

cn-hangzhou
VirtualNodeNamestring

虚拟节点名称。

testNode
VirtualNodeIdsstring

虚拟节点 ID 序列。最多 20 个,字符串需按照 JSON 格式传入。

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

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。只支持 ASCII 字符,且不能超过 64 个字符。更多详情,请参阅如何保证幂等性

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

虚拟节点状态。取值范围:

  • Pending
  • Ready
  • Failed
Ready
ResourceGroupIdstring

资源组 ID。

rg-uf66jeqopgqa9hdn****
NextTokenstring

下一个查询开始的 Token,NextToken 为空表示没有下一个。

首次查询时无需设置该参数,后续查询的 Token 从返回结果中获取。

d78f2dd8-5979-42fe-****-b16db43be5bc
Limitlong

限制本次查询返回的资源数量。默认返回 20 个,最大不能超过 20 个。

说明 返回结果可能小于指定的数量,但不会多于指定的数量。
20
Tagobject []

虚拟节点绑定的标签列表。

Keystring

标签键。

name
Valuestring

标签值。

test

返回参数

名称类型描述示例值
object
TotalCountinteger

查询到的虚拟节点数量。

1
NextTokenstring

下一个查询开始的 Token。

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

请求 ID。

9C9B9917-ED22-50D5-ADE6-9FA9D58AD05F
VirtualNodesobject []

虚拟节点信息集合。

Statusstring

虚拟节点状态。可能值:

  • Pending
  • Ready
  • Failed
Ready
CreationTimestring

虚拟节点创建时间。UTC 时间,RFC 3339 标准。

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

虚拟节点所属的 VPC ID。

vpc-1vzjjflab6wvjox****
InternetIpstring

虚拟节点的公网 IP。

192.0.XX.XX
Tagsobject []

虚拟节点绑定的标签信息。

Keystring

标签键。

name
Valuestring

标签值。

test
Eventsobject []

事件信息。

Typestring

事件类型。可能值:

  • Normal
  • Warning
Normal
LastTimestampstring

事件结束时间。

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

事件消息。

Successfully
Namestring

事件的归属对象名。

test
Reasonstring

事件名。

Created
Countinteger

事件数。

1
FirstTimestampstring

事件开始时间。

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

虚拟节点 ID。

vnd-2ze960zkdqrldeaw****
IntranetIpstring

虚拟节点的内网 IP。

10.19.XX.XX
RegionIdstring

虚拟节点所属的地域 ID。

cn-hangzhou
VirtualNodeVSwitchIdstring

虚拟节点所属的交换机 ID。

vsw-2ze23nqzig8inprou****
VirtualNodeSecurityGroupIdstring

虚拟节点所属的安全组 ID。

sg-2zeeyaaxlkq9sppl****
ResourceGroupIdstring

虚拟节点所属的资源组 ID。

rg-uf66jeqopgqa9hdn****
VirtualNodeNamestring

虚拟节点的名称。

testNode

示例

正常返回示例

JSON格式

{
  "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"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400Account.ArrearageYour account has an outstanding payment.账号已经欠费。
400DryRunOperationRequest validation has been passed with DryRun flag set.此次DryRun预检请求合格。
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.容器组内有重复名字的数据卷。
400IncorrectStatus%s指定的实例状态不正确。
400ServiceNotEnabled%s该次请求所依赖的服务没有开通,请开通后再试。
400ImageSnapshot.IncorrectStatus%s用于镜像缓存的快照状态不正确。
400ImageSnapshot.NotSupport%s基于数据盘快照的镜像缓存功能暂未全网开放,如有需要请联系我们。
400DiskVolume.NotSupportThe disk volume is not supported.云盘卷暂不支持,如有需要请联系我们。
400RamRole.NotSupportThe RAM role is not supported.ram实例角色不支持。
400DiskNumber.LimitExceedThe 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.您的账户暂无有效支付方式,请添加支付方式或保持预付款余额充足。
400DiskVolume.NotInSameZoneThe 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.您需要申请CPU高配白名单。
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.您的付款信用额度不足。
400InvalidOperation.KMS.InstanceTypeNotSupportThe specified instance is invalid. Only I/O optimized instances support KMS key.指定的实例无效,只有 I/O 优化类型的实例支持设置“KMS Key”。
400InvalidParameter.Encrypted.KmsNotEnabledKMS must be enabled for encrypted disks.加密磁盘需要启用密钥管理服务。
400InvalidParameter.KMS.EncryptedIllegalAfter configuring the parameter KmsKeyId, you must enable encryption.设置参数“KmsKeyId”后,您必须开启加密属性。
400Ipv6AddressNotSupportVswIPv6 is not supported in the specified vSwitch.该交换机暂未开通ipv6地址。
403OperationDenied.VswZoneMisMatchThe specified VSwitchId is not in the specified Zone.-
403QuotaExceeded%s quota exceeded.用户允许创建的实例已经超过限制。
403Zone.NotOnSaleThe specified zone is not available for purchase.创建实例的可用区已经关闭售卖,请更换其他可用区。或者无法在该可用区使用指定 VPC 的虚拟交换机。
403Forbidden.RiskControlThis operation has been identified as an abnormal operation and cannot be processed.此操作已被确定为一个操作异常,无法处理。
403Forbidden.SubUserThe specified action is not available for you.当前用户无法执行该操作。
403Forbidden.OnlyForInvitedTestEci create action is only open to invited users during public beta.Eci公测阶段只对受邀的用户开放。
403OperationDenied.SecurityGroupMisMatchThe specified VSwitchId and SecurityGroupId are not in the same VPC.指定的交换机和安全组不在同一个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.子账号用户没有权限使用RAM实例角色。
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.无权访问指定的 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.请确保账号拥有ram:CreateServiceLinkedRole权限。
404ImageSnapshot.NotFoundThe specified snapshot does not exist.镜像缓存,快照不存在。
404InvalidDiskId.NotFoundThe specified disk does not exist.指定的云盘不存在。
404InvalidParameter.KMS.KeyId.NotFoundThe specified KMSKeyId does not exist.指定的参数“KMSKeyId”不存在。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-08-30OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
出参OpenAPI 返回结构发生变更
2023-07-03OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
出参OpenAPI 返回结构发生变更
2021-09-06新增 OpenAPI看变更集
  • 本页导读 (1)
文档反馈