本接口用于为一台或多台ECS实例授予RAM角色。
接口说明
您可以通过 DescribeInstanceRamRole 查询实例被授予的实例 RAM 角色。
说明
如果实例已存在被授予的实例 RAM 角色，则报错提示您不能授予新的角色。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| ecs:AttachInstanceRamRole | update | *Instance acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}*Role acs:ram:{#regionId}:{#accountId}:role/{#roleName} |
|
|
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
| RamRoleName | string | 是 | 实例 RAM 角色名称。您可以使用 RAM API ListRoles 查询您已创建的实例 RAM 角色。 | testRamRoleName |
| InstanceIds | string | 是 | 实例 ID 数组。数组长度：1~100。 | [“i-bp14ss25xca5ex1u****”, “i-bp154z5o1qjalfse****”, “i-bp10ws62o04ubhvi****] |
| Policy | string | 否 | 额外权限策略。可以指定一个额外的权限策略，以进一步限制 RAM 角色的权限。更多信息，请参见权限策略概览。长度为 1~1024 个字符。 | {"Statement": [{"Action": ["*"],"Effect": "Allow","Resource": ["*"]}],"Version":"1"} |
返回参数
示例
正常返回示例
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，请检查您的角色策略。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-12-17 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更 | 查看变更详情 |
| 2023-07-10 | OpenAPI 错误码发生变更 | 查看变更详情 |