ListGroups - 获取服务器分组列表_云安全中心(Security Center)-阿里云帮助中心

获取用户的主机服务器分组列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
Lang	string	否	设置请求和接收消息的语言类型，默认为 zh。取值： zh：中文 en：英文	zh
CurrentPage	integer	否	返回数据当前页的页码。起始值为 1，默认值为 1。	89
PageSize	integer	否	指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为 20 条，最大 2000。	10
NextToken	string	否	是否拥有下一次查询的令牌（Token）。如果 NextToken 为空表示没有下一次查询。如果 NextToken 有返回值，该取值表示下一次查询开始的令牌。	1426C575705AE8545E8360A6EFA3B***
UseNextToken	boolean	否	是否使用 NextToken 方式拉取漏洞列表数据。如果使用此参数 TotalCount 不再返回。取值： true：使用 NextToken 方式 false：不使用 NextToken 方式	true

返回参数

名称	类型	描述	示例值
	object	PageResult
List	array<object>	分组列表。
List	object	分组。
GroupId	long	服务器分组 ID。	11028542
GroupName	string	服务器分组名称。	cn-shenzhen+dir-1440978***
GroupFlag	integer	服务器分组类型。取值： 0：默认分组 1：其他分组	1
PageInfo	object	查询结果页面显示的信息。
CurrentPage	integer	分页查询时，当前页的页码。	1
PageSize	integer	分页大小。	10
TotalCount	integer	数据的总条数。	202
Count	integer	当前页显示的数据条数。	4
NextToken	string	使用 NextToken 方式下返回的 NextToken 值。	B604532DEF982B875E8360A6EFA3B***
Success	boolean	异常事件处理的结果状态。取值： true：处理成功。 false：处理失败。	true
Code	string	接口请求返回的状态码。	200
Message	string	错误码的详细信息。	successful
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	CB414DB5-F692-5DAB-9F0F-975C060AF***
HttpStatusCode	integer	HTTP 状态码。	200

示例

正常返回示例

JSON格式

{
  "List": [
    {
      "GroupId": 11028542,
      "GroupName": "cn-shenzhen+dir-1440978***",
      "GroupFlag": 1
    }
  ],
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 10,
    "TotalCount": 202,
    "Count": 4,
    "NextToken": "B604532DEF982B875E8360A6EFA3B***"
  },
  "Success": true,
  "Code": 200,
  "Message": "successful",
  "RequestId": "CB414DB5-F692-5DAB-9F0F-975C060AF***",
  "HttpStatusCode": 200
}

错误码

HTTP status code	错误码	错误信息	描述
403	NoPermission	caller has no permission	当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作。
500	ServerError	ServerError	服务故障，请稍后重试！

访问错误中心查看更多错误码。