GetQuota - 获取资源配额详情

更新时间:
复制 MD 格式

您可以通过GetQuota获取一个资源配额详情,以了解当前资源使用情况,方便进行资源管理和规划。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

pai:GetQuota

none

*全部资源

*

请求语法

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

路径参数

名称

类型

必填

描述

示例值

QuotaId

string

获取详细信息的 Quota identifier。

quota1ci8g79****

请求参数

名称

类型

必填

描述

示例值

Verbose

boolean

是否显示详细信息。

true

WithNodeMeta

boolean

是否返回绑定到 Quota 的节点 meta 信息

返回参数

名称

类型

描述

示例值

object

返回内容。

AllocateStrategy

string

资源分配策略。

ByNodeSpec

CreatorId

string

Quota 创建人 ID。

1884692****

Description

string

Quota 描述。

this is a test quota

GPUType

string

GPU 卡型

L20

GmtCreatedTime

string

Quota 创建时间。

2023-06-22T00:00:00Z

GmtModifiedTime

string

Quota 修改时间。

2023-06-22T00:00:00Z

HyperZones

array

高性能网络区列表

string

高性能网络区 ID

A3

Labels

array

Quota 标签。

Label

label key value 对。

LatestOperationId

string

Quota 最近变更 ID。

operation****

Min ResourceSpec

Min Quota 配置。

ParentQuotaId

string

父 Quota ID。

quota1ci8g79****

QueueStrategy

string

Quota 上任务的排队策略。

PaiStrategyIntelligent

QuotaCluster

QuotaCluster

由配额内资源组成的集群规格与状态

QuotaConfig QuotaConfig

Quota 对应配置:

  • VPC 信息

  • 是否支持 RDMA

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

QuotaDetails QuotaDetails

Quota 的详情。

QuotaId

string

资源配额 ID。

quotajradxh4****

QuotaName

string

资源配额名称。

test-quota

ReasonCode

string

错误码。

“”

ReasonMessage

string

错误原因。

“”

RequestId

string

请求 ID。

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

ResourceGroupIds

array

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

string

资源组 ID。

rg69rj0leslw****

ResourceType

string

Quota 资源类型。

ECS

Status

string

Quota 状态。

Ready

SubQuotas

array

Quota 的子 Quota 列表。

QuotaIdName

包含的子 Quota 的 ID。

Version

string

版本信息。当 resource type 为 ECS 时生效。

1.0

Workspaces

array

Quota 关联的工作空间。

WorkspaceIdName

所关联的工作空间信息。

示例

正常返回示例

JSON格式

{
  "AllocateStrategy": "ByNodeSpec",
  "CreatorId": "1884692****",
  "Description": "this is a test quota",
  "GPUType": "L20",
  "GmtCreatedTime": "2023-06-22T00:00:00Z",
  "GmtModifiedTime": "2023-06-22T00:00:00Z",
  "HyperZones": [
    "A3"
  ],
  "Labels": [
    {
      "Key": "testAccTag",
      "Value": "nihao"
    }
  ],
  "LatestOperationId": "operation****",
  "Min": {
    "NodeSpecs": [
      {
        "Type": "ecs.g6.4xlarge",
        "Count": 10,
        "BindingPolicy": {
          "NodeSpecCount": 5,
          "IncludeNodes": [
            "lrnabc"
          ],
          "ExcludeNodes": [
            "lrndef"
          ]
        },
        "HyperType": ""
      }
    ]
  },
  "ParentQuotaId": "quota1ci8g79****",
  "QueueStrategy": "PaiStrategyIntelligent",
  "QuotaCluster": {
    "ClusterType": "",
    "Image": "",
    "DataSources": [
      {
        "DataSourceId": "",
        "MountPath": "",
        "Uri": ""
      }
    ],
    "Endpoints": {
      "key": ""
    },
    "Status": ""
  },
  "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,
            "Spec": {
              "CPU": "100",
              "Memory": "100Gi",
              "GPU": "16",
              "GPUType": "GPU"
            },
            "CodeType": "\"\"",
            "Code": "\"\"",
            "Reason": "\"\""
          }
        ]
      }
    ],
    "EnablePreemptSubquotaWorkloads": false,
    "EnableSubQuotaPreemption": true,
    "SubQuotaPreemptionConfig": {
      "PreemptedPriorityUpperBound": 9,
      "PreemptedProducts": [
        "dlc"
      ]
    },
    "EnableGPUShare": true,
    "OversoldUsageConfig": {
      "DisabledBy": "",
      "Disabled": true
    },
    "SelfQuotaPreemptionConfig": {
      "PreemptorPriorities": [
        0
      ],
      "PreemptedPriorities": [
        0
      ],
      "PreemptedProducts": [
        ""
      ]
    },
    "EniCacheConfig": {
      "Enabled": true,
      "CachePoolSize": 0
    },
    "SandboxCacheConfig": {
      "Enabled": true
    },
    "UseCase": "",
    "EnableSelfQuotaPreemption": true,
    "ControlPlaneClusterId": "",
    "IsEncryptedResource": true,
    "WorkloadTypes": [
      ""
    ]
  },
  "QuotaDetails": {
    "DesiredMinQuota": {
      "CPU": "100",
      "Memory": "100Gi",
      "GPU": "16",
      "GPUType": "GPU"
    },
    "ActualMinQuota": {
      "CPU": "100",
      "Memory": "100Gi",
      "GPU": "16",
      "GPUType": "GPU"
    },
    "NodeStatistics": {
      "ActualMinNodeNum": 0,
      "ActualMinHyperNodeNum": 0,
      "AllocatedNodeNum": 0,
      "AllocatedHyperNodeNum": 0,
      "EmptyNodeNum": 0,
      "AllocatedHyperNodeDetails": [
        {
          "HyperNodeName": "",
          "AllocatedNodeNum": 0,
          "TotalNodeNum": 0,
          "EmptyNodeNum": 0
        }
      ]
    }
  },
  "QuotaId": "quotajradxh4****",
  "QuotaName": "test-quota",
  "ReasonCode": "“”",
  "ReasonMessage": "“”",
  "RequestId": "18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E",
  "ResourceGroupIds": [
    "rg69rj0leslw****"
  ],
  "ResourceType": "ECS",
  "Status": "Ready",
  "SubQuotas": [
    {
      "QuotaId": "quota12345",
      "QuotaName": "dlc-quota"
    }
  ],
  "Version": "1.0",
  "Workspaces": [
    {
      "WorkspaceId": "ws123***",
      "WorkspaceName": ""
    }
  ]
}

错误码

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

变更历史

更多信息,参考变更详情