You need to enable JavaScript to run this app.
导航
AssetList - 资产列表查询
最近更新时间:2024.07.15 11:06:26首次发布时间:2024.03.28 17:09:34

根据资产开启状态查询资产列表信息。

请求说明

  • 请求方式:POST
  • 请求地址:https://open.volcengineapi.com/?Action=AssetList&Version=2021-09-06

调试

请求参数

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

参数
类型
是否必填
示例值
描述
Action
String

AssetList

要执行的操作,取值:AssetList。

Version
String

2021-09-06

API的版本,取值:2021-09-06。

page_size
Integer

1

分页大小,默认值为 10

current_page
Integer

1

当前页码,默认值为 1

stat
Integer

0

开关状态

  • 0:全部
  • 1:开
  • 2:关
asset
String

test

资产名称 或 资产IP

asset_type
Array of String

["ECS"]

资产类型

  • NAT
  • ECS
  • CLB
  • HAVIP
  • ENI
  • ALB
  • WAF

返回参数

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

参数
类型
示例值
描述
TotalCount
Integer

1

返回数据总数量。当查询数据为空时,且使用 Python SDK 调用时此项为 None。

PageSize
Integer

1

返回数据的分页大小。

PageNumber
Integer

1

返回数据的当前页码。

Count
Integer

1

返回数据的实际数量。当查询数据为空时,且使用 Python SDK 调用时此项为 None。

Data
Array of Object

参见结构示例值

返回的资产数据。

请求示例

POST /?Action=AssetList&Version=2021-09-06 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20240711T092201Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240711/cn-beijing/fw_center/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "page_size": 5,
  "current_page": 1,
  "stat": 0,
  "asset_type": [
    "ECS",
    "NAT"
  ]
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202407111722212501142421005BFA18",
    "Version": "2021-09-06",
    "Service": "fw_center",
    "Action":"AssetList",
    "Region": "cn-beijing"
  },
  "Result":{
      "TotalCount":1,
      "PageSize":5,
      "PageNumber":1,
      "Count":1,
      "Data":[
          {
              "ID":1234567,
              "AccountID":"21*****",
              "ip":"10.249.**.**",
              "name":"ECS-eEuE",
              "region":"cn-beijing",
              "cluster":1234567,
              "type":"ECS",
              "enable":false
          }
      ]
  }
}

错误码

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

状态码
错误码
错误信息
说明
400
InvalidParameter
非法的参数。请检查%s。

请求中缺乏某个参数或者某个参数校验失败,请参考错误信息,根据 API 接口文档修改对应的参数。

400
BadRequest
错误的请求。请检查http请求或者联系管理员!

请求无法被正确地解析,请重新构建请求,或者通过工单联系相关人员进行处理。

500
InternalError
内部错误。请联系管理员!

请求过程中发生了一些非预期的错误,请通过工单联系相关人员进行处理。