修改训练配额 - ModifyTrainingQuotas
功能介绍
修改训练配额接口用于修改用户在ModelArts服务中的训练资源配额信息。
该接口适用于以下场景:当管理员需要调整用户的训练资源配额(如作业个数配额、自动老化开关、配额告警通知等)时,可以通过此接口进行修改。使用该接口的前提条件是用户已登录并具有修改配额的权限。修改成功后,用户的训练资源配额将被更新。若用户无权限或配额信息无效,接口将返回相应的错误信息。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
PUT /v2/{project_id}/training-quotas
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释:用户项目ID。获取方法请参见获取项目ID和名称。 约束限制:1 - 64字符,字母、数字和中划线。 取值范围:不涉及。 默认取值:不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| user_id | 是 | String | 参数解释:用户ID。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
| quotas | 是 | Array of ModifyTrainingQuotaItem objects | 参数解释:训练作业配额组。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| resource | 是 | String | 参数解释:配额的资源类型。 约束限制:不涉及。 取值范围:枚举值如下: 默认取值:不涉及。 |
| quota | 是 | Integer | 参数解释:配额个数。 约束限制:取值约束因资源类型而异:job-retention-enabled取值0(关闭)或1(开启);job-num-quota-notify固定为0,通知主题URN存于extra_info;其余资源类型要求不小于1。 取值范围:0 ~ 2147483647。 默认取值:不涉及。 |
| used | 否 | Integer | 参数解释:已使用的个数。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
| extra_info | 否 | String | 参数解释:配额的额外信息。 约束限制:当resource为job-num-quota-notify时,该字段存储SMN通知主题URN。 取值范围:不涉及。 默认取值:不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| user_id | String | 参数解释:用户ID。 取值范围:不涉及。 |
| quotas | Array of ModifyTrainingQuotaItem objects | 参数解释:训练作业配额组。 |
请求示例
如下以修改用户ID为fa412c98-6d94-42a2-891a-99cd1da93916的作业个数配额为例。
PUT https://{endpoint}/v2/{project_id}/training-quotas
{
"user_id" : "fa412c98-6d94-42a2-891a-99cd1da93916",
"quotas" : [ {
"resource" : "job-num",
"quota" : 20000
} ]
} 响应示例
状态码:200
修改训练配额响应体
{
"user_id" : "fa412c98-6d94-42a2-891a-99cd1da93916",
"quotas" : [ {
"resource" : "job-num",
"quota" : 20000
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 修改训练配额响应体 |
错误码
请参见错误码。