DocsICP FilingConsole
官方文档
首页

DescribeCloudDriveGroups

更新时间：
复制 MD 格式
产品详情
我的收藏

Query the list and basic information of all team shared drives in the enterprise cloud drive.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecd:DescribeCloudDriveGroups

list

*All Resource

*

 None None

Request parameters

Parameter

Type

Required

Description

Example
RegionId

string

Yes

The region ID.

cn-hangzhou
CdsId

string

Yes

The ID of the cloud disk in Cloud Drive Service.

cn-shanghai+cds-135515****
GroupId

array

No

The team ID.

string

No

The team ID.

cg-i1ruuudp92qpj****
GroupName

string

No

The team name for fuzzy search.

测试团队1
ParentGroupId

string

No

The ID of the parent node. If a parent node ID is specified, the subnodes are queried. If you set the value of this parameter to root, the root node is queried.

Default value: null. The default value indicates that all nodes are queried.

cg-e70ga4ixp30ur****
DriveStatus

string

No

The team space status. Valid values:

  • enabled

  • disabled

Default value: enabled.

Valid values:

  • disabled :

    禁用

  • enabled :

    可用 [默认值]

enabled
GroupType

string

No

The team type.

  • org: organizational structure

  • directory: workspace

Default value: null. The default value indicates that all types of teams are queried.

Valid values:

  • org :

    组织架构

  • directory :

    办公网络

org
DriveType

string

Yes

Specifies whether the space is increased.

  • binding: increased

  • unbound: not increased

Default value: null. The default value indicates that all spaces are queried.

Valid values:

  • unbound :

    没有添加空间

  • binding :

    添加了空间

binding
DirectoryId

string

No

The workspace ID.

cn-hangzhou+dir-jedbpr4sl9l37****
DirectoryName

string

No

The workspace name.

testDirectoryName

MaxResults

integer

No

The number of entries to return on each page.

  • Valid values: 1 to 100

  • Default value: 20

10
NextToken

string

No

The pagination token that is used in the next request to retrieve a new page of results.

AAAAAV3MpHK1AP0pfERHZN5pu6lY3I2VNHLwy+nIoSXh****

Response elements

Element

Type

Description

Example

object

NextToken

string

The returned value of NextToken is a pagination token, which can be used in the next request to retrieve a new page of results.

AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****
RequestId

string

The request ID.

EF015AE5-B30A-5189-B519-735CEE40****
Count

integer

The total number of entries returned.

0
Success

boolean

Indicates whether the request was successful.

Valid values:

  • true :

    成功

  • false :

    失败

true
CloudDriveGroups

array<object>

The list of team spaces.

array<object>

Status

string

The team space status. Valid values:

  • enabled

  • disabled

Default value: enabled.

Valid values:

  • disabled :

    禁用

  • enabled :

    可用 [默认值]

enabled
GroupId

string

The team ID.

cg-e70ga4ixp30ur****
GroupName

string

The name of the team space.

测试团队1
DirectoryId

string

The workspace ID.

cn-hangzhou+dir-959593****
DriveId

string

The team space ID.

sh1234
CreateTime

string

The time when the team space was created.

2022-04-11T07:44:21Z
TotalSize

integer

The total capacity of the team space.

5368709120
UsedSize

string

The capacity of the used space. Unit: bytes.

1024000000
RecycleBinSize

string

Size of the recycle bin for the team space. Unit: Byte.

1024000
AdminUserIds

string

List of group administrators.

["user01"]
OrgId

string

Organization ID of the team.

org-aliyun-wy-org-id
AdminUserInfos

array<object>

Administrator information for the group space.

object

EndUserId

string

Administrator username (may be unreadable when imported from a third party).

user01
NickName

string

Administrator nickname.

张三
RealNickName

string

Administrator nickname.

张三
Remark

string

Remark.

张三
Phone

string

Phone number.

12345678
Email

string

Mailbox.

123@aliyun.com
JobNumber

string

Job number (DingTalk)

12345

Examples

Success response

JSON format

{
  "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****",
  "RequestId": "EF015AE5-B30A-5189-B519-735CEE40****",
  "Count": 0,
  "Success": true,
  "CloudDriveGroups": [
    {
      "Status": "enabled",
      "GroupId": "cg-e70ga4ixp30ur****",
      "GroupName": "测试团队1",
      "DirectoryId": "cn-hangzhou+dir-959593****",
      "DriveId": "sh1234",
      "CreateTime": "2022-04-11T07:44:21Z",
      "TotalSize": 5368709120,
      "UsedSize": "1024000000",
      "RecycleBinSize": "1024000",
      "AdminUserIds": "[\"user01\"]",
      "OrgId": "org-aliyun-wy-org-id",
      "AdminUserInfos": [
        {
          "EndUserId": "user01",
          "NickName": "张三",
          "RealNickName": "张三",
          "Remark": "张三",
          "Phone": "12345678",
          "Email": "123@aliyun.com",
          "JobNumber": "12345"
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.