文档

DescribeAssetDetailByUuids - 查询资产的详情

更新时间:

查询资产(ECS服务器)的详细信息。

调试

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

授权信息

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

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

请求参数

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

资产实例的 UUID 列表。多个 UUID 之间使用半角逗号(,)分隔。

0687b17f-2a36-4e5****,0687b17f-2a36-4e****
Langstring

设置请求和接收消息的语言类型,默认为 zh。取值:

  • zh:中文
  • en:英文
zh
ResourceDirectoryAccountIdlong

资源目录成员账号主账号 ID。

说明 调用 DescribeMonitorAccounts 接口可以获取该参数。
127608589417****

返回参数

名称类型描述示例值
object
RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

92016EC8-D52D-49D8-9FF7-9EA340A950B9
AssetListobject []

返回的资产详情列表。

InternetIpstring

服务器的公网 IP。

10.10.XX.XX
OsNamestring

服务器资产的操作系统名称。

CentOS 7.6 64位
Ipstring

服务器的 IP。

说明 公网 IP 存在则该值为公网 IP,公网 IP 不存在私网 IP 存在则为私网 IP。
10.10.XX.XX
Osstring

服务器的操作系统类型。

Linux
InstanceIdstring

资产的实例 ID。

i-rj9gda4wolo0zixi****
ClientStatusstring

Agent 客户端状态。取值:

  • online:在线
  • offline:离线
online
VpcInstanceIdstring

VPC 实例 ID。

13231-331331
IntranetIpstring

服务器的私网 IP。

192.168.XX.XX
AssetTypestring

资产的类型。

唯一取值为 0,表示 ECS 服务器。

0
RegionIdstring

服务器所在地域。

说明 Region ID 和区域名称的对应关系,请参见地域和可用区
cn-shanghai
Uuidstring

资产 UUID。

2a98f149-0256-414c-a29a-a69f8a75****
Flaginteger

资产厂商。取值:

  • 0:阿里云资产
  • 1:云外资产
  • 2:IDC 资产
  • 3457:其它云资产
  • 8:轻量级资产
0
RegionNamestring

服务器所在地域名称。

cn-shenzhen
InstanceNamestring

资产的实例名称。

TestInstanceName
Regionstring

服务器所在的地域。

cn-guangzhou

示例

正常返回示例

JSON格式

{
  "RequestId": "92016EC8-D52D-49D8-9FF7-9EA340A950B9",
  "AssetList": [
    {
      "InternetIp": "10.10.XX.XX",
      "OsName": "CentOS  7.6 64位",
      "Ip": "10.10.XX.XX",
      "Os": "Linux",
      "InstanceId": "i-rj9gda4wolo0zixi****",
      "ClientStatus": "online",
      "VpcInstanceId": "13231-331331",
      "IntranetIp": "192.168.XX.XX",
      "AssetType": "0",
      "RegionId": "cn-shanghai",
      "Uuid": "2a98f149-0256-414c-a29a-a69f8a75****",
      "Flag": 0,
      "RegionName": "cn-shenzhen",
      "InstanceName": "TestInstanceName",
      "Region": "cn-guangzhou"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400IllegalParamIllegal param无效参数
400RdCheckNoPermissionResource directory account verification has no permission.资源目录账号校验无权限。
403NoPermissioncaller has no permission当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作。
500RdCheckInnerErrorResource directory account service internal error.资源目录账号服务内部错误。
500ServerErrorServerError服务故障,请稍后重试!

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

变更历史

变更时间变更内容概要操作
2023-07-20OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    新增错误码:500
入参OpenAPI 入参发生变更
    新增入参:ResourceDirectoryAccountId
2022-12-23OpenAPI 描述信息更新、OpenAPI 去除了 deprecated 标记、OpenAPI 错误码发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
API 弃用说明(deprecated)OpenAPI 去除了 deprecated 标记
错误码OpenAPI 错误码发生变更
    删除错误码:400
  • 本页导读 (1)
文档反馈