GetQuota - 获取资源配额详情

您可以通过GetQuota获取一个Quota详情。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
pai:GetQuotanone
*全部资源
*

请求语法

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

请求参数

名称类型必填描述示例值
QuotaIdstring

获取详细信息的 Quota identifier。

quota1ci8g793pgm
Verboseboolean

是否显示详细信息

true

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

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

资源配额 ID。

quotajradxh43rgb
QuotaNamestring

资源配额名称。

test-quota
ResourceTypestring

Quota 资源类型。

ECS
ParentQuotaIdstring

父 Quota ID。

quota1ci8g793pgm
ResourceGroupIdsarray

资源配额对应的资源组信息。

ResourceGroupIdItemstring

资源组 ID。

rg69rj0leslwdnbe
AllocateStrategystring

资源分配策略。

ByNodeSpec
MinResourceSpec

Min Quota 配置。

Descriptionstring

Quota 描述。

this is a test quota
Labelsarray

Quota 标签。

LabelItemLabel

label key value 对。

CreatorIdstring

Quota 创建人 ID。

18846926616
LatestOperationIdstring

Quota 最近变更 ID。

operation1234
Statusstring

Quota 状态。

Ready
ReasonCodestring

错误码。

“”
ReasonMessagestring

错误原因。

“”
GmtCreatedTimestring

Quota 创建时间。

2023-06-22T00:00:00Z
GmtModifiedTimestring

Quota 修改时间。

2023-06-22T00:00:00Z
QuotaDetailsQuotaDetails

Quota 详情。

QuotaConfigQuotaConfig

Quota 对应配置:

  • VPC 信息

  • 是否支持 RDMA

  • ACS 对应配置(若资源类型为 ACS 生效)

Workspacesarray

Quota 关联的工作空间。

WorkspaceItemWorkspaceIdName

所关联的工作空间信息。

SubQuotasarray

Quota 的子 Quota 列表。

SubQuotaItemQuotaIdName

包含的子 Quota 的 ID。

QueueStrategystring

Quota 上任务的排队策略。

PaiStrategyIntelligent

示例

正常返回示例

JSON格式

{
  "RequestId": "18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E",
  "QuotaId": "quotajradxh43rgb",
  "QuotaName": "test-quota",
  "ResourceType": "ECS",
  "ParentQuotaId": "quota1ci8g793pgm",
  "ResourceGroupIds": [
    "rg69rj0leslwdnbe"
  ],
  "AllocateStrategy": "ByNodeSpec",
  "Min": {
    "NodeSpecs": [
      {
        "Type": "ecs.g6.4xlarge",
        "Count": 10
      }
    ]
  },
  "Description": "this is a test quota",
  "Labels": [
    {
      "Key": "testAccTag",
      "Value": "nihao"
    }
  ],
  "CreatorId": "18846926616",
  "LatestOperationId": "operation1234",
  "Status": "Ready",
  "ReasonCode": "“”",
  "ReasonMessage": "“”",
  "GmtCreatedTime": "2023-06-22T00:00:00Z",
  "GmtModifiedTime": "2023-06-22T00:00:00Z",
  "QuotaDetails": {
    "DesiredMinQuota": {
      "CPU": "100",
      "Memory": "100Gi",
      "GPU": "16",
      "GPUType": "GPU"
    },
    "ActualMinQuota": {
      "CPU": "100",
      "Memory": "100Gi",
      "GPU": "16",
      "GPUType": "GPU"
    },
    "RequestedQuota": {
      "CPU": "100",
      "Memory": "100Gi",
      "GPU": "16",
      "GPUType": "GPU"
    }
  },
  "QuotaConfig": {
    "SupportRDMA": false,
    "ClusterId": "ceeb3724255364***",
    "UserVpc": {
      "VpcId": "vpc-abcdef****",
      "SwitchId": "vs-abcdef****",
      "SecurityGroupId": "sg-abcdef****",
      "ExtendedCIDRs": [
        "\"192.168.0.1/24\""
      ],
      "RoleArn": "acs:ram::25xxxx:role/AliyunPAIDLCDefaultRole",
      "DefaultRoute": "eth0",
      "DefaultForwardInfo": {
        "NatGatewayId": "nat-7j4mka9wguxj",
        "EipAllocationId": "eip-h29r78ieufbih"
      }
    },
    "SupportGPUDrivers": [
      "470.199.02"
    ],
    "DefaultGPUDriver": "470.199.02",
    "ACS": {
      "ACSQuotaId": "rq-3kbt2gtimmyw7fgfgothocvh",
      "AssociatedProducts": [
        "PAI-DLC"
      ]
    },
    "ResourceSpecs": [
      {
        "WorkspaceId": "122421",
        "Product": "DLC",
        "Specs": [
          {
            "SpecName": "spec_test",
            "IsGuaranteedValid": true,
            "IsOverSoldValid": true,
            "CodeType": "\"\"",
            "Code": "\"\"",
            "Reason": "\"\""
          }
        ]
      }
    ],
    "EnablePreemptSubquotaWorkloads": false
  },
  "Workspaces": [
    {
      "WorkspaceId": "ws123***"
    }
  ],
  "SubQuotas": [
    {
      "QuotaId": "quota12345",
      "QuotaName": "dlc-quota"
    }
  ],
  "QueueStrategy": "PaiStrategyIntelligent"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-05-09OpenAPI 入参发生变更查看变更详情