Queries the statistics of a directory.
Operation description
This topic provides an example on how to query the statistics of a directory whose ID is d-00fc2p61****. The statistics include the number of users, quota for users, number of groups, quota for groups, number of access configurations, quota for access configurations, quota for system policies that can be configured for an access configuration, number of access permissions that are assigned, number of System for Cross-domain Identity Management (SCIM) credentials, number of asynchronous tasks, status of single sign-on (SSO), and status of SCIM synchronization.
Limit
You can call this operation up to 100 times per second per account. This operation is globally limited to 100 times per second across all accounts. If the number of the calls per second exceeds a limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limits when you call this operation.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| cloudsso:GetDirectoryStatistics | Read |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| DirectoryId | string | Yes | The ID of the directory. | d-00fc2p61**** |
For more information about common request parameters, see Common parameters.
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "7B7228B0-A435-5D27-A6B2-ED3571F0654B",
"DirectoryStatistics": {
"UserCount": 16,
"GroupCount": 4,
"UserQuota": 1000,
"GroupQuota": 500,
"AccessConfigurationQuota": 1000,
"AccessAssignmentCount": 5,
"SCIMServerCredentialCount": 2,
"DirectoryId": "d-00fc2p61****",
"SSOEnabled": false,
"Region": "cn-shanghai",
"AccessConfigurationCount": 6,
"DirectoryName": "new-example",
"InProgressTaskCount": 0,
"SCIMSyncEnabled": true,
"SystemPolicyPerAccessConfigurationQuota": 20
}
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation | ||
|---|---|---|---|---|
| 2023-09-04 | The response structure of the API has changed | see changesets | ||
|