GetQuota

更新时间:
复制 MD 格式

Call GetQuota to retrieve the details of a resource quota. This helps you monitor current resource usage for effective resource management and planning.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

pai:GetQuota

none

*All Resource

*

None None

Request syntax

GET /api/v1/quotas/{QuotaId} HTTP/1.1

Path Parameters

Parameter

Type

Required

Description

Example

QuotaId

string

No

The ID of the resource quota.

quota1ci8g79****

Request parameters

Parameter

Type

Required

Description

Example

Verbose

boolean

No

Specifies whether to return detailed information.

true

WithNodeMeta

boolean

No

Specifies whether to return the metadata of nodes that are attached to the resource quota.

Response elements

Element

Type

Description

Example

object

The response body.

RequestId

string

The request ID.

18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E

QuotaId

string

The ID of the resource quota.

quotajradxh4****

QuotaName

string

The name of the resource quota.

test-quota

ResourceType

string

The resource type of the quota.

ECS

ParentQuotaId

string

The ID of the parent resource quota.

quota1ci8g79****

ResourceGroupIds

array

The resource groups that are associated with the resource quota.

string

The ID of the resource group.

rg69rj0leslw****

AllocateStrategy

string

The resource allocation policy.

ByNodeSpec

Min ResourceSpec

The configuration of the minimum quota.

Description

string

The description of the resource quota.

this is a test quota

Labels

array

The labels of the resource quota.

Label

The key-value pair of the label.

CreatorId

string

The ID of the user who created the resource quota.

1884692****

LatestOperationId

string

The ID of the most recent change to the resource quota.

operation****

Status

string

The status of the resource quota.

Ready

ReasonCode

string

The error code.

“”

ReasonMessage

string

The cause of the error.

“”

GmtCreatedTime

string

The time when the resource quota was created.

2023-06-22T00:00:00Z

GmtModifiedTime

string

The time when the resource quota was last modified.

2023-06-22T00:00:00Z

QuotaDetails

QuotaDetails

The details of the resource quota.

QuotaConfig QuotaConfig

The configurations of the resource quota:

  • VPC information

  • Whether Remote Direct Memory Access (RDMA) is supported

  • ACS configurations, which take effect if the resource type is ACS

Workspaces

array

The workspaces that are associated with the resource quota.

WorkspaceIdName

The information about the associated workspaces.

SubQuotas

array

A list of sub-quotas of the resource quota.

QuotaIdName

The IDs of the sub-quotas.

QueueStrategy

string

The queuing policy for tasks in the resource quota.

PaiStrategyIntelligent

Version

string

The version information. This parameter takes effect when ResourceType is set to ECS.

1.0

HyperZones

array

A list of high-performance network zones.

string

The ID of a high-performance network zone.

A3

QuotaCluster

QuotaCluster

The specifications and status of the cluster that is composed of resources within the quota.

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.