文档

GetOrgGroup - 查询群组信息

更新时间:

通过 OpenAPI 查询群组信息。

适用版本

企业专属版

服务接入点与授权信息

请求语法

GET  https://<domain>/oapi/v1/platform/organizations/<organizationId>/groups/<id>

请求头

参数

类型

是否必填

描述

示例值

x-yunxiao-token

string

个人访问令牌。

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

请求参数

参数

类型

位置

是否必填

描述

示例值

organizationId

string

path

企业 ID。

99d1****71d4

id

string

path

群组 ID。

8446****ce9f

请求示例

curl -X 'GET' \
  'https://test.rdc.aliyuncs.com/oapi/v1/platform/organizations/<organizationId>/groups/<id>' \
  -H 'accept: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

返回参数

参数

类型

描述

示例值

description

string

描述。

id

string

群组 ID。

8446****ce9f

name

string

群组名称。

name1

organizationId

string

组织 ID。

99d1****71d4

返回示例

{
  "description": "string",
  "id": "8446****ce9f",
  "name": "name1",
  "organizationId": "99d1****71d4"
}

错误码

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