云安全中心
以树形结构查询主机多级分组详情及各节点关联主机数。GroupID 不传时返回所有一级分组;GroupName 支持按分组路径模糊匹配。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 | ListLayeredGroupsDetail | 要执行的操作,取值:ListLayeredGroupsDetail。 |
Version | String | 是 | 2024-05-08 | API的版本,取值:2024-05-08。 |
GroupName | String | 否 | production | 分组名称,按完整分组路径模糊匹配;不传时不按名称筛选,结果会保留匹配分组的上级链路 |
GroupID | String | 否 | group-id-001 | 分组 ID,可通过本接口不传筛选条件时获取;不传时返回所有一级分组 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
Total | Long | 25 | 返回分组树覆盖的主机总数 |
Groups | Array of Object | -- | 多级分组树列表 |
POST /?Action=ListLayeredGroupsDetail&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 { "GroupID": "group-id-001", "GroupName": "production" }
{ "ResponseMetadata": { "RequestId": "20241120165538010234567890", "Action": "ListLayeredGroupsDetail", "Version": "2024-05-08", "Service": "seccenter", "Region": "cn-beijing" }, "Result": { "Groups": [ { "Children": [], "GroupID": "group-id-101", "GroupIdPath": "/group-id-001/group-id-101", "GroupName": "web", "GroupPath": "/production/web", "HostCount": 12, "Level": 2, "ParentID": "group-id-001", "TopGroupID": "group-id-001" } ], "Total": 25 } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
状态码 | 错误码 | 错误信息 | 说明 |
|---|---|---|---|
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. | 服务器内部错误,请稍后重试或联系技术支持。 |
500 | DBOperateError | The request has failed because database return error: %s | 数据库操作异常,请稍后重试或联系技术支持。 |