ListQuotas - 获取资源配额列表_人工智能平台 PAI(PAI)-阿里云帮助中心

您可以通过ListQuotas获取资源配额列表。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
pai:ListQuotas	none	全部资源 *	无	无

请求语法

GET /api/v1/quotas/ HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
QuotaName	string	否	按照 QuotaName 过滤，支持模糊匹配。	quotajradxh43rgb
ResourceType	string	否	Quota 资源类型（Lingjun/ECS/ACS），默认值 ECS。	ECS
LayoutMode	string	否	展示方式，可以为树形或列表	Tree
ParentQuotaId	string	否	按 ParentQuotaId 过滤：不传，列出租户下所有 Quota，包含根 Quota 和子 Quota。传空，列出所有的根 Quota。传非空，列出指定 ParentQuotaId 的所有子 Quota。	quotajradxh43rgb
QuotaIds	string	否	逗号分隔，按 QuotaIds 过滤，只支持精确匹配，最多同时支持 100 个。	quota1ci8g793pgm,quotajradxh43rgb
WorkspaceIds	string	否	逗号分隔，按 WorkspaceIds 过滤，只支持精确匹配，最多同时支持 10 个。	21345,38727
Statuses	string	否	逗号分隔按照 Quota Statuses 过滤，只支持精确匹配。	Creating
PageNumber	integer	否	查询第几页数据，最小值为 1。	1
PageSize	integer	否	设置查询的分页大小，最小值为 1。	20
SortBy	string	否	返回结果的排序字段名，枚举值： QuotaName Status CPU Memory GPU GmtCreatedTime GmtModifiedTime	status
Order	string	否	排列顺序：desc 或者 asc。	desc
Labels	string	否	按照 Label 的 key 和 value 进行过滤，多个标签使用半角逗号（,）分隔。	official=true,gpu=false
Verbose	boolean	否	是否显示详情。取值如下： true：显示详情。 false：不显示详情。	true
WorkspaceName	string	否	所关联的工作空间名称。	myshellprod

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	F082BD0D-21E1-5F9B-81A0-AB07485B03CD
Quotas	array	资源配额列表。
QuotaItem	Quota	单个资源配额详情。
TotalCount	integer	总记录数	23

示例

正常返回示例

JSON格式

{
  "RequestId": "F082BD0D-21E1-5F9B-81A0-AB07485B03CD",
  "Quotas": [
    {
      "QuotaId": "quota12345",
      "QuotaName": "dlc-quota",
      "ResourceType": "ECS",
      "ParentQuotaId": "\"\"",
      "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": "ceeb3724255364664",
        "UserVpc": {
          "VpcId": "vpc-abcdef****",
          "SwitchId": "vs-abcdef****",
          "SecurityGroupId": "sg-abcdef****",
          "ExtendedCIDRs": [
            "\"192.168.0.1/24\""
          ],
          "RoleArn": "acs:ram::25xxxx:role/AliyunPAIDLCDefaultRole",
          "DefaultRoute": "eth0"
        },
        "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": true
      },
      "Workspaces": [
        {
          "WorkspaceId": "ws123456"
        }
      ],
      "SubQuotas": [
        {
          "QuotaId": "quota12345",
          "QuotaName": "dlc-quota"
        }
      ],
      "QueueStrategy": "PaiStrategyIntelligent"
    }
  ],
  "TotalCount": 23
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-07-04	OpenAPI 入参发生变更	查看变更详情
2024-05-09	OpenAPI 入参发生变更	查看变更详情
2024-03-19	OpenAPI 返回结构发生变更	查看变更详情
2024-01-24	OpenAPI 入参发生变更	查看变更详情