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

云安全中心

复制全文
下载 pdf
HIDS_AGENT
ListCloudEnvs - 获取云环境列表
复制全文
下载 pdf
ListCloudEnvs - 获取云环境列表

分页查询当前账户已接入的云环境及云平台、同步开关、同步状态和最近同步时间。

调试

请求参数

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

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

ListCloudEnvs

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

Version
String
是

2024-05-08

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

Status
Long
否

0

开关状态筛选:0 关闭、1 开启;不传时不按开关状态筛选

SyncStatus
Long
否

0

同步状态筛选:0 异常、1 正常;不传时不按同步状态筛选

AccessKey
String
否

AKLTEXAMPLE001

主账号或子账号AK

PageNumber
Long
是

1

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

SortBy
String
否

LastHeartbeatTime

排序字段。支持取值:cloud_platform(云平台)、status(状态)、sync_status(同步状态)、comment(备注)、access_key(Access Key)、insert_time(创建时间)、update_time(更新时间)、_id。未指定时默认 _id(记录 ID)升序(最早在前)。

SortOrder
String
否

Desc

排序顺序

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

volcengine

云平台标识

Comment
String
否

example description

备注信息

PageSize
Long
是

20

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

返回参数

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

参数
类型
示例值
描述
Data
Array of Object

--

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

PageNumber
Long

1

当前页面

PageSize
Long

20

页面大小

TotalCount
Long

1

全部数据条数

请求示例

POST /?Action=ListCloudEnvs&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

{
  "AccessKey": "AKLTEXAMPLE001",
  "CloudPlatform": "volcengine",
  "Comment": "example description",
  "PageNumber": 1,
  "PageSize": 20,
  "SortBy": "LastHeartbeatTime",
  "SortOrder": "Desc",
  "Status": 0,
  "SyncStatus": 0
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241120165538010234567890",
    "Action": "ListCloudEnvs",
    "Version": "2024-05-08",
    "Service": "seccenter",
    "Region": "cn-beijing"
  },
  "Result": {
    "Data": [
      {
        "AccessKey": "AK",
        "CloudPlatform": "volcengine",
        "Comment": "example description",
        "ErrorMsg": "invalid request parameter",
        "ID": "resource-id-001",
        "KeyType": "default",
        "Status": 0,
        "SyncPeriod": 60,
        "SyncStatus": 0
      }
    ],
    "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.10.30 14:06:14
这个页面对您有帮助吗?
有用
有用
无用
无用