Updated on 2024-11-01 GMT+08:00

Querying Resource Sharing Quotas

Function

This API is used to query resource sharing quotas in the current account.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

GET https://{endpoint}/v1/resource-shares/quotas

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

X-Security-Token

No

String

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

quotas

QuotaResourcesDto object

List of resource sharing quotas.

Table 3 QuotaResourcesDto

Parameter

Type

Description

resources

Array of Quotas objects

Quota information.

Table 4 Quotas

Parameter

Type

Description

type

String

Quota type. resource_share indicates the number of resource shares allowed to be created by the current account; resource_association indicates the number of resources allowed to be associated with a resource share; principal_association indicates the number of principals allowed to be associated with a resource share; permission_association indicates the number of permissions allowed to be associated with a resource share; tag_association indicates the number of tags allowed to be associated with a resource share.

quota

Integer

Total number of quotas.

min

Integer

Minimum quota.

max

Integer

Maximum quota.

used

Integer

Used quotas.

Example Requests

Querying resource sharing quotas for the current account

GET https://{endpoint}/v1/resource-shares/quotas

Example Responses

Status code: 200

Request succeeded.

{
  "quotas" : {
    "resources" : [ {
      "type" : "string",
      "quota" : 0,
      "min" : 0,
      "max" : 1,
      "used" : 0
    } ]
  }
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.