ListGroups - 获取服务器分组列表

更新时间:
复制 MD 格式

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

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-sas:ListGroups

list

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

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>

分组列表。

object

分组。

GroupId

integer

服务器分组 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

错误码

错误信息

描述

500 ServerError ServerError
403 NoPermission caller has no permission

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

变更历史

更多信息,参考变更详情