ListOrgGroups - 查询组织群组列表

通过 OpenAPI 查询组织群组列表。

适用版本

企业专属版

服务接入点与授权信息

请求语法

GET https://{domain}/oapi/v1/platform/organizations/{organizationId}/groups

请求头

参数

类型

是否必填

描述

示例值

x-yunxiao-token

string

个人访问令牌。

pt-0fh3****0fbG_35af****0484

请求参数

参数

类型

位置

是否必填

描述

示例值

organizationId

string

path

组织 ID。

99d1****71d4

page

integer

query

当前页,默认1。

1

perPage

integer

query

每页数据条数,默认100。

100

请求示例

curl -X 'GET' \
  'https://test.rdc.aliyuncs.com/oapi/v1/platform/organizations/{organizationId}/groups?page={page}&perPage={perPage}' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

返回参数

参数

类型

描述

示例值

-

array

-

object

description

string

群组描述。

示例描述

id

string

群组 ID。

99d1****6124

name

string

群组名称。

示例名

organizationId

string

组织 ID。

99d1****6124

返回示例

[
    {
        "description": "示例描述",
        "id": "99d1****6124",
        "name": "示例名",
        "organizationId": "99d1****6124"
    }
]

响应头

参数

描述

示例值

x-next-page

下一页。

1

x-page

当前页。

2

x-per-page

每页数据条数。

100

x-prev-page

上一页。

1

x-total

总数据量。

2

x-total-pages

总分页数。

1

错误码

访问错误码中心查看 API 相关错误码。