DescribeAccessGroups -

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	DEFAULT_VPC_GROUP_NAME	The name of the permission group. Limits: The name must be 3 to 64 characters in length. The name must start with a letter and can contain letters, digits, underscores (_), and hyphens (-).
PageSize	Integer	No	2	The number of entries to return on each page. Valid values: 1 to 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 to display the creation time of the permission group in UTC. Valid values: true (default value): The time is displayed in UTC. false: The time is not displayed in UTC.
FileSystemType	String	No	standard	The type of the file system. Valid values: standard (default value): General-purpose NAS file system extreme: Extreme NAS file system cpfs: Cloud Parallel File Storage (CPFS) file system

Response parameters


Parameter	Type	Example	Description
AccessGroups	Array of AccessGroup		The list of permission groups.
AccessGroup
AccessGroupName	String	DEFAULT_VPC_GROUP_NAME	The name of the permission group.
Description	String	This is a test access group.	The description of the permission group.
CreateTime	String	2020-01-05T16:00:00Z	The time when the permission group was created.
AccessGroupType	String	Vpc	The network type of the permission group. Valid values: Vpc: virtual private cloud (VPC) Classic: the classic network
RuleCount	Integer	0	The total number of rules in the permission group.
MountTargetCount	Integer	0	The number of mount targets to which the permission group is attached.
TotalCount	Integer	1	The total number of permission groups.
RequestId	String	2514F97E-FFF0-4A1F-BF04-729CEAC6****	The ID of the request.
PageSize	Integer	2	The number of permission groups returned per page.
PageNumber	Integer	1	The page number of the returned page.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeAccessGroups
&AccessGroupName=DEFAULT_VPC_GROUP_NAME
&PageSize=2
&PageNumber=1
&UseUTCDateTime=true
&FileSystemType=standard
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeAccessGroupsResponse>
    <AccessGroups>
        <AccessGroupName>DEFAULT_VPC_GROUP_NAME</AccessGroupName>
        <Description>This is a test access group.</Description>
        <CreateTime>2020-01-05T16:00:00Z</CreateTime>
        <AccessGroupType>Vpc</AccessGroupType>
        <RuleCount>0</RuleCount>
        <MountTargetCount>0</MountTargetCount>
    </AccessGroups>
    <TotalCount>1</TotalCount>
    <RequestId>2514F97E-FFF0-4A1F-BF04-729CEAC6****</RequestId>
    <PageSize>2</PageSize>
    <PageNumber>1</PageNumber>
</DescribeAccessGroupsResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "AccessGroups" : [ {
    "AccessGroupName" : "DEFAULT_VPC_GROUP_NAME",
    "Description" : "This is a test access group.",
    "CreateTime" : "2020-01-05T16:00:00Z",
    "AccessGroupType" : "Vpc",
    "RuleCount" : 0,
    "MountTargetCount" : 0
  } ],
  "TotalCount" : 1,
  "RequestId" : "2514F97E-FFF0-4A1F-BF04-729CEAC6****",
  "PageSize" : 2,
  "PageNumber" : 1
}

Error codes

For a list of error codes, see Service error codes.