为实例授予RAM角色

接口说明


本接口用于为一台或多台ECS实例授予RAM角色。

使用须知:

  1. 一台实例仅允许绑定一个RAM角色。

  2. 您可以通过获取角色列表接口获取角色名称。

  3. 您可以进入【访问控制RAM】-【角色】页面,选择【移动云服务】-【创建RAM角色】。

注意事项:

  1. 关机状态实例不支持授予RAM角色。

推荐使用API Explorer调试

API Explorer支持接口在线可视化调用,同时自动生成动态代码示例,搭配OpenAPI SDK无需计算签名实现接口快速集成。

URL

POST https://ecloud.10086.cn/api/openapi-instance/v4/ram/attach-role

请求参数

Body

参数名称
类型
必填
描述
serverRoleReq
ServerRoleReq
是

serverRoleReq

instanceIds
<string> array
是

实例ID数组,可通过查询实例状态列表接口获取。

ramRoleName
string
是

RAM角色名称。

请求示例

POST https://ecloud.10086.cn/api/openapi-instance/v4/ram/attach-role
{
	"ramRoleName":"test-ram",
	"instanceIds":[
		"574cdc2d-f96a-4540-bbd1-2e38ca1d6042"
	]
}

返回参数

返回码:200
OK
参数名称
类型
描述
body
BatchAction«InstanceActionResult»

请求成功时返回的数据。

instanceBatchResult
<InstanceActionResult> array

实例批量操作结果集。

instanceId
string

实例ID。

result
boolean

操作是否下发成功。

message
string

操作结果信息,失败时返回错误信息,成功时返回空字符串。

errorCode
string

统一错误码。

errorMessage
string

页面国际化错误提示。

errorParams
<string> array

统一错误码的自定义参数。

requestId
string

每个请求的序列号。

state
enum(OK,ERROR,EXCEPTION,ALARM,FORBIDDEN)

返回状态码。返回正常:OK,返回错误:ERROR,返回异常:EXCEPTION,需要告警实现的:ALARM,禁止访问:FORBIDDEN。

返回示例

返回码:200
OK
{
	"body":true,
	"requestId":"reqId-49b078faacbc1dc85d66c-a156faae-6",
	"state":"OK"
}
本文档内容整理自移动云官方帮助中心(查看原文),仅供参考。