查询工作空间配额
功能介绍
查询工作空间配额接口用于获取指定工作空间的资源配额信息。
该接口适用于以下场景：当用户需要了解工作空间的资源使用情况和配额限制时，可以通过此接口获取详细数据。使用该接口的前提条件是工作空间已存在且用户具有查看该工作空间配额的权限。查询操作完成后，接口将返回工作空间的配额信息，包括但不限于计算资源、存储资源、网络资源的配额和已使用量。若工作空间不存在或用户无权限操作，接口将返回相应的错误信息。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/workspaces/{workspace_id}/quotas
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释：用户项目ID。获取方法请参见获取项目ID和名称。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
workspace_id |
是 |
String |
参数解释：工作空间ID。未创建工作空间时默认值为“0”，存在创建并使用的工作空间，以实际取值为准。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释：用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
quotas |
Array of WorkspaceQuotasResponse objects |
参数解释：工作空间配额数据。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
max_quota |
Integer |
参数解释：配额允许设置的最大值。 取值范围：不涉及。 |
|
update_time |
Integer |
参数解释：最后修改时间，UTC。如用户未修改过该资源配额,则该值默认为该工作空间的创建时间。 取值范围：不涉及。 |
|
resource |
String |
参数解释：资源的唯一标识。 取值范围：不涉及。 |
|
quota |
Integer |
参数解释：当前配额值。配额值为-1代表不限制配额。 取值范围：不涉及。 |
|
min_quota |
Integer |
参数解释：配额允许设置的最小值。 取值范围：不涉及。 |
|
name_cn |
String |
参数解释：配额名称(中文)。 取值范围：不涉及。 |
|
unit_cn |
String |
参数解释：数量单位(中文)。 取值范围：不涉及。 |
|
name_en |
String |
参数解释：配额名称（英文）。 取值范围：不涉及。 |
|
unit_en |
String |
参数解释：数量单位(英文)。 取值范围：不涉及。 |
|
used_quota |
Integer |
参数解释：已用配额值。当quota为-1（不限制配额）时，used_quota为null。 取值范围：不涉及。 |
请求示例
GET https://{endpoint}/v1/{project_id}/workspaces/ccd05d1a553b4e188ea878e7dcb85e47/quotas
响应示例
状态码：200
查询工作空间配额成功的响应参数。
{
"quotas" : [ {
"max_quota" : 60000,
"update_time" : 1470000020000,
"resource" : "exemlProject.gpu_duration",
"used_quota" : 5,
"quota" : 10,
"min_quota" : -1,
"name_cn" : "自动学习（图像分类、物体检测、声音分类）训练时长",
"unit_cn" : "分钟",
"name_en" : "ExeMLtraining duration (image classification, object detection, and soundclassification)",
"unit_en" : "minute"
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
查询工作空间配额成功的响应参数。 |
错误码
请参见错误码。
