一键授权或重置授权 - CreateAuthGrant
功能介绍
一键授权或重置授权接口用于一键创建ModelArts委托授权或重置已有委托。该接口适用于以下场景:当用户首次使用ModelArts服务需要开通委托授权时,或当现有委托授权出现异常、过期需要重新配置时,可通过此接口一键完成授权操作。使用该接口的前提条件是用户已登录系统且具有相应的操作权限。执行一键授权后,系统将自动创建委托授权关系;执行重置操作后,原有委托将被替换为新的授权。若用户无权限操作或服务异常,接口将返回相应的错误信息。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v2/{project_id}/auth/grant
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释:用户项目ID,获取方法请参见获取项目ID和名称。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
请求参数
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| service_name | String | 参数解释:服务名称。 取值范围:不涉及。 |
| status | Boolean | 参数解释:授权状态,true表示已授权,false表示未授权。 取值范围: |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误描述 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误描述 |
请求示例
{
"is_reset" : false
} 响应示例
无
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 委托授权成功响应。 |
| 400 | Error response |
| 403 | 委托已存在但无法查询,需手动删除。 |
错误码
请参见错误码。