Queries the details of permission groups.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description 
Action String Yes DescribeAccessGroups

The operation that you want to perform. Set the value to DescribeAccessGroups.

AccessGroupName String No classic-test

The name of the permission group.

PageSize Integer No 2

The number of entries to return on each page.

  • Maximum value: 100.
  • Default value: 10.
PageNumber Integer No 1

The number of the page to return.

  • Pages start from page 1.
  • Default value: 1.
UseUTCDateTime Boolean No true

Specifies whether the time to return is in UTC. Valid values: true and false.

FileSystemType String No standard

The type of file system.

  • Valid values: standard and extreme.
  • Default value: standard.

Response parameters

Parameter Type Example Description
RequestId String 2514F97E-FFF0-4A1F-BF04-729CEAC64B6F

The ID of the request.

TotalCount Integer 2

The total number of permission groups.

PageSize Integer 2

The number of entries returned per page.

PageNumber Integer   1

The page number of the returned page.

AccessGroups Array

The details of permission groups.

AccessGroupName String classic-test

The name of each permission group.

AccessGroupType String Classic

The type of permission group. Valid values: VPC and Classic.

RuleCount Integer  0

The total number of rules that are included in the permission group.

MountTargetCount Integer  0

The number of mount targets that have the permission group applied.

Description String This is a classic test access group~

The description of the permission group.

Examples

Sample requests

http(s)://[Endpoint]/? Action=DescribeAccessGroups
&<Common request parameters>

Sample success responses

XML format

<DescribeAccessGroupsResponse>
    <PageNumber>1</PageNumber>
    <TotalCount>2</TotalCount>
    <PageSize>2</PageSize>
    <RequestId>3E569F4A-F743-490B-AC01-A8088F5C17A1</RequestId>
    <AccessGroups>
        <AccessGroup>
            <Description>DEFAULT ACCESS GROUP NAME</Description>
            <nodeCount>1</nodeCount>
            <AccessGroupType>Vpc</AccessGroupType>
            <AccessGroupName>DEFAULT_VPC_GROUP_NAME</AccessGroupName>
            <MountTargetCount>8</MountTargetCount>
        </AccessGroup>
        <AccessGroup>
            <Description>This is a classic test access group~</Description>
            <RuleCount>0</RuleCount>
            <AccessGroupType>Classic</AccessGroupType>
            <AccessGroupName>classic-test</AccessGroupName>
            <MountTargetCount>0</MountTargetCount>
        </AccessGroup>
    </AccessGroups>
</DescribeAccessGroupsResponse>

JSON format

{
  "AccessGroups": {
    "AccessGroup": [
      {
        "RuleCount": 1,
        "AccessGroupType": "Vpc",
        "Description": "DEFAULT ACCESS GROUP NAME",
        "AccessGroupName": "DEFAULT_VPC_GROUP_NAME",
        "MountTargetCount": 8
      },
      {
        "RuleCount": 0,
        "AccessGroupType": "Classic",
        "Description": "This is a classic test access group~",
        "AccessGroupName": "classic-test",
        "MountTargetCount": 0
      }
    ]
  },
  "TotalCount": 2,
  "PageSize": 2,
  "RequestId": "2514F97E-FFF0-4A1F-BF04-729CEAC64B6F",
  "PageNumber": 1
}

Error codes

For a list of error codes, visit the API Error Center.