获取训练配额 - ShowTrainingQuotas
功能介绍
获取训练配额接口用于查询用户在ModelArts服务中的训练资源配额信息。
该接口适用于以下场景:当用户需要了解当前可用的训练资源配额,以便合理规划和管理训练任务时,可以通过此接口获取配额详情。使用该接口的前提条件是用户已登录并具有查看配额的权限。响应消息体中包含用户已创建的训练作业个数、剩余可创建个数等。若用户无权限或配额信息为空,接口将返回相应的错误信息或空列表。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。获取该接口关联的CLI示例: hcloud ModelArts ShowTrainingQuotas。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v2/{project_id}/training-quotas
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释:用户项目ID。获取方法请参见获取项目ID和名称。 约束限制:1 - 64字符,字母、数字和中划线。 取值范围:不涉及。 默认取值:不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
user_id |
否 |
String |
参数解释:用户ID。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
|
resource |
否 |
String |
参数解释:配额的资源类型。 约束限制:当前支持的传参:job-num(作业个数的配额)。 取值范围:不涉及。 默认取值:不涉及。 |
请求参数
无
请求示例
GET https://endpoint/v2/{project_id}/training-quotas?user_id=fa412c98-6d94-42a2-891a-99cd1da93916&resource=job-num
响应示例
状态码:200
训练作业配额响应体
{
"quotas" : [ {
"resource" : "job-num",
"quota" : 10000,
"used" : 25
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
训练作业配额响应体 |
错误码
请参见错误码。