You need to enable JavaScript to run this app.
文档中心
云安全中心

云安全中心

复制全文
下载 pdf
HIDS_MLP
ListDevBasicInfos - 获取开发机基本信息列表
复制全文
下载 pdf
ListDevBasicInfos - 获取开发机基本信息列表

分页查询开发机实例 ID、名称、IP、区域和防护状态等轻量信息,用于选择器和批量操作。

调试

请求参数

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

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

ListDevBasicInfos

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

Version
String
是

2024-05-08

API的版本,取值:2024-05-08。

AssetId
String
否

asset-id-001

资产ID

AssetIds
Array of String
否

["asset-id-001"]

资产ID列表, 不为空时忽略其他参数

AssetName
String
否

example-name

资产名称

IP
String
否

192.0.2.10

资产IP

IsAll
Boolean
否

true

是否查询全部资产, 为true时忽略其他参数

PageNumber
Long
是

1

翻页页码,取值范围为 1 及以上

PageSize
Long
是

20

每页记录数,取值范围为 1~5000

Platforms
Array of String
否

["linux"]

操作系统:ListAssetDevPlatform接口获取

Regions
Array of String
否

["cn-beijing"]

地域: ListAssetDevRegion接口获取

Risk
Object
否

--

Risk

SecurityEnhancement
Boolean
否

true

安全防护开关是否开启

SortBy
String
否

LastHeartbeatTime

排序字段;不传时使用接口默认排序

SortOrder
String
否

Desc

排序顺序

  • Asc 升序排列
  • Desc 降序排列
ProtectStatus
String
否

Protecting

防护状态 未防护:Unprotected 防护中:Protecting

Status
Array of String
否

["Running"]

运行状态,可选值:Running(运行中)、Stopped(已停止)

返回参数

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

参数
类型
示例值
描述
PageNumber
Long

1

当前页面

PageSize
Long

20

页面大小

TotalCount
Long

1

全部数据条数

Data
Array of Object

--

分页业务数据,具体元素结构见各接口响应声明

请求示例

POST /?Action=ListDevBasicInfos&Version=2024-05-08 HTTP/1.1
Host: seccenter.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20241120T080538Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20241120/cn-beijing/seccenter/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "AssetId": "asset-id-001",
  "AssetIds": [
    "asset-id-001"
  ],
  "AssetName": "example-name",
  "IP": "192.0.2.10",
  "IsAll": true,
  "PageNumber": 1,
  "PageSize": 20,
  "Platforms": [
    "linux"
  ],
  "ProtectStatus": "Protecting",
  "Regions": [
    "cn-beijing"
  ],
  "Risk": {
    "Alarm": true,
    "Baseline": true,
    "Virus": true,
    "Vuln": true
  },
  "SecurityEnhancement": true,
  "SortBy": "LastHeartbeatTime",
  "SortOrder": "Desc",
  "Status": [
    "Running"
  ]
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241120165538010234567890",
    "Action": "ListDevBasicInfos",
    "Version": "2024-05-08",
    "Service": "seccenter",
    "Region": "cn-beijing"
  },
  "Result": {
    "Data": [
      {
        "AccountId": "account-id-001",
        "AssetId": "asset-id-001",
        "AssetName": "example-name",
        "PrivateIP": "192.0.2.10",
        "ProtectStatus": "Protecting",
        "PublicIP": "192.0.2.10",
        "SecurityEnhancement": true,
        "Status": "success"
      }
    ],
    "PageNumber": 1,
    "PageSize": 20,
    "TotalCount": 1
  }
}

错误码

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

状态码
错误码
错误信息
说明
400
MissingParameter

The required parameter %s is missing.

请求参数缺失,请检查参数是否已正确传入。

400
InvalidParameter

The specified parameter %s is invalid.

请求参数错误,请检查参数传递内容是否正确。

400
OperationDenied

Operation is denied because the specified resource is in use.

不允许的操作,请检查当前资源是否被占用

500
InternalError

The request has failed due to an unknown error.

服务器内部错误,请稍后重试或联系技术支持。

500
DBOperateError

The request has failed because database return error: %s

数据库操作异常,请稍后重试或联系技术支持。

最近更新时间:2026.08.21 20:30:52
这个页面对您有帮助吗?
有用
有用
无用
无用