AttachInstanceRamRole - 为实例授予RAM角色 - 云服务器 ECS

调用AttachInstanceRamRole为一台或多台ECS实例授予实例RAM角色。如果实例已有RAM角色，则报错提示您不能附加新的角色。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。	cn-hangzhou
RamRoleName	string	是	实例 RAM 角色名称。您可以使用 RAM API ListRoles 查询您已创建的实例 RAM 角色。	testRamRoleName
InstanceIds	string	是	实例 ID。取值可以由多个实例 ID 组成一个 JSON 数组，最多支持 100 个 ID，ID 之间用半角逗号（,）隔开。	[“i-bp14ss25xca5ex1u**”, “i-bp154z5o1qjalfse”, “i-bp10ws62o04ubhvi**”…]
Policy	string	否	权限策略。长度为 1~1024 个字符。为一台或多台 ECS 实例授予实例 RAM 角色时，可以指定一个额外的权限策略，以进一步限制 RAM 角色的权限。更多信息，请参见权限策略概览。	{"Statement": [{"Action": [""],"Effect": "Allow","Resource": [""]}],"Version":"1"}

返回参数

名称	类型	描述	示例值
	object
RamRoleName	string	实例 RAM 角色的名称。	testRamRoleName
RequestId	string	请求 ID。	D9553E4C-6C3A-4D66-AE79-9835AF705639
TotalCount	integer	授予的实例 RAM 角色总个数。	1
FailCount	integer	授予实例 RAM 角色的失败个数。	0
AttachInstanceRamRoleResults	array<object>	由实例 RAM 角色类型（AttachInstanceRamRoleResult）组成的信息集。
AttachInstanceRamRoleResult	object
Code	string	判断是否成功授予实例 RAM 角色。返回值为 200 表示成功授予，返回其他值表示授予失败，失败原因参见错误码。	200
Message	string	判断是否成功授予实例 RAM 角色。返回值为 Success 表示成功授予，返回其他值表示授予失败，失败原因参见错误码。	success
InstanceId	string	实例 ID。	i-bp10ws62o04ubhvi****
Success	boolean	是否成功授予实例 RAM 角色。	true

示例

正常返回示例

JSON格式

{
  "RamRoleName": "testRamRoleName",
  "RequestId": "D9553E4C-6C3A-4D66-AE79-9835AF705639",
  "TotalCount": 1,
  "FailCount": 0,
  "AttachInstanceRamRoleResults": {
    "AttachInstanceRamRoleResult": [
      {
        "Code": "200",
        "Message": "success",
        "InstanceId": "i-bp10ws62o04ubhvi****",
        "Success": true
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidInstanceIds.Malformed	The specified instanceIds are not valid.	指定的多个 InstanceId 不合法。
403	InvalidNetworkType.MismatchRamRole	Ram role cannot be applied to instances of Classic network type.	实例 RAM 角色不能被用于经典网络类型的实例，RAM 角色只能使用在 VPC 类型的实例上。
403	InvalidUser.PassRoleForbidden	The RAM user does not have the privilege to pass a RAM role.	该 RAM 用户无权传递 RAM 角色。
404	InvalidInstanceId.NotFound	The specified instanceId does not exist.	指定的实例ID未找到。
404	InvalidRamRole.NotFound	The specified RAMRoleName does not exist.	指定的 RamRoleName 不存在。
404	InvalidRamRole.NotEcsRole	The specified ram role is not authorized for ecs, please check your role policy.	指定的 RAM 角色无权使用 ECS，请检查您的角色策略。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2023-07-10	OpenAPI 错误码发生变更	查看变更详情