文档

ListGroup - 列举群组

更新时间:

列举群组。

调试

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

授权信息

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

请求语法

POST /v2/group/list HTTP/1.1

请求参数

名称类型必填描述示例值
bodyobject

请求体参数

limitinteger

限定此次返回资源的数量。如果不设定,默认返回 100,最大不能超过 100。

100
markerstring

设定结果从 marker 之后按字母排序的第一个开始返回。如果不设定,则从头开始返回数据。 默认值:无

NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg

返回参数

名称类型描述示例值
object

Schema of Response

itemsarray

群组列表

Group

群组信息

next_markerstring

下一页起始资源标识符, 最后一页该值为空。

NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg

示例

正常返回示例

JSON格式

{
  "items": [
    {
      "domain_id": "bj1",
      "group_id": "b45c0c0c373c41ec9ebb5c85a025a08f",
      "group_name": "test group",
      "description": "created by system",
      "created_at": 1670573504600,
      "updated_at": 1670573504600,
      "creator": "c9b7a5aa04d14ae3867fdc886fa01da4",
      "is_sync": true
    }
  ],
  "next_marker": "NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg"
}

错误码

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