PostApiV1AssetDescribeDetail - 查询资产详情--多云安全平台-火山引擎

文档中心

立即注册

导航

PostApiV1AssetDescribeDetail - 查询资产详情

最近更新时间：2024.11.06 17:01:31首次发布时间：2024.11.06 17:01:31

查询指定资产的详情信息，包括资产ID、名称、类型、厂商、地区、网络信息（公私网IP、私有网络、子网）等。

请求说明

请求方式: POST
请求地址: https://open.volcengineapi.com/?Action=PostApiV1AssetDescribeDetail&Version=2023-05-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	PostApiV1AssetDescribeDetail	要执行的操作，取值：PostApiV1AssetDescribeDetail。
Version	String	是	2023-05-01	API的版本，取值：2023-05-01。
resource_vendor	String	是	volcengine	云厂商
resource_type	String	是	ComputeVm	资产类型
resource_cloud_account_id	String	是	900000000123	资产所属云账号ID
resource_id	String	是	i-ydexxxxxxxx	资产ID

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
resource_vendor	String	volcengine	云厂商
resource_type	String	ComputeVm	资产类型
resource_id	String	i-2ze2exxxxixypvyycxay	资产ID
resource_name	String	launch-advisor-20241031	资产名称
region	String	cn-beijing	资产所属区域
resource_cloud_account_id	String	900000000123	所属云账号ID
resource_cloud_account_name	String	volc-account-1	所属云账号名称
cloud_product_type	String	volc-ecs	云产品类型
created_time_milli	Long	1730367960000	资产创建时间
business_tag_ids	Array of String	[ "业务标签-1", "业务标签-2" ]	业务标签ID列表
security_labels_tag_ids	Array of String	[ "security_label_tag_1", "security_label_tag_2" ]	安全标签ID列表
security_situation_tag_ids	Array of String	[ "ExistAlarmRisk", "ExistVulnRisk", "ExistCSPMRisk" ]	安全状况标签ID列表
updated_op_records	Array of Object		变更操作记录

请求示例

POST /?Action=PostApiV1AssetDescribeDetail&Version=2023-05-01 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20241105T031802Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20241105/cn-beijing/mcs/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "resource_vendor": "volcengine",
  "resource_type": "ComputeVm",
  "resource_cloud_account_id": "900000000123",
  "resource_id": "i-ydexxxxxxxx"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241105112246184172027102F4C59E",
    "Action": "PostApiV1AssetDescribeDetail",
    "Version": "2023-05-01",
    "Service": "mcs",
    "Region": "cn-beijing"
  },
  "Result": {
    "resource_vendor": "volcengine",
    "resource_type": "ComputeVm",
    "resource_id": "i-2ze2exxxxixypvyycxay",
    "resource_name": "launch-advisor-20241031",
    "region": "cn-beijing",
    "resource_cloud_account_id": "900000000123",
    "resource_cloud_account_name": "volc-account-1",
    "cloud_product_type": "volc-ecs",
    "created_time_milli": 1730367960000,
    "business_tag_ids": [
      "业务标签-1",
      "业务标签-2"
    ],
    "security_labels_tag_ids": [
      "security_label_tag_1",
      "security_label_tag_2"
    ],
    "security_situation_tag_ids": [
      "ExistAlarmRisk",
      "ExistVulnRisk",
      "ExistCSPMRisk"
    ],
    "updated_op_records": [
      {
        "op_time_milli": 1730737417000,
        "op_detail": "机器重启"
      }
    ]
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidParameter	The specified parameter %s is invalid.	无效参数
400	OperationDenied	Operation is denied because the specified resource is in use.	操作被拒绝
400	MissingParameter	The required parameter %s is missing.	缺失参数
500	InternalError	The request has failed due to an unknown error.	内部错误