Querying Resource Sharing Quotas

Function

This API is used to query the resource sharing quota of 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.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

ram:resourceShares:listQuota

List

-

-

-

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
ram:resourceShares:listQuota	List	-	-	-	-

URI

GET /v1/resource-shares/quotas

Request Parameters

**Table 1** Request header parameters
Parameter	Mandatory	Type	Description
X-Security-Token	No	String	Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required.

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: number of resource shares created by an account. resource_association: number of resources associated with a resource share. principal_association: number of principals associated with a resource share. permission_association: number of permissions associated with a resource share. tag_association: number of tags 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 the resource sharing quota of the current account

GET /v1/resource-shares/quotas

Example Responses

Status code: 200

Request succeeded.

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