AssociateInstancesIamRole

最近更新时间：2023.07.25 18:39:31

首次发布时间：2022.07.01 09:22:08

调用 AssociateInstancesIamRole 接口为一台或多台实例绑定IAM角色，一台实例仅允许用户绑定一个IAM角色。

说明

执行该操作前，您需要为IAM角色授予云服务器ECS相关权限，详细信息请参见访问控制IAM概述。

请求参数

名称	类型	是否必填	示例值	描述
Action	String	是	AssociateInstancseIamRole	要执行的操作，取值：AssociateInstancesIamRole。
Version	String	是	2020-04-01	API的版本，取值： 2020-04-01。
InstanceIds.N	String	是	InstanceIds.1=i-3ti9101aju3vj0****& InstanceIds.2= i-3tiegs1y963vj0****	实例ID，最多支持100个ID。参数 - N：表示实例的序号。多个Instance ID之间用&分隔。
IamRoleName	String	是	EcsTestRole	实例IAM角色名称。您可以使用ListRoles查询您已创建的实例IAM角色。一台实例仅允许用户绑定一个IAM角色。
ClientToken	String	否	333456899ff****	保证请求幂等性。由客户端自动生成一个参数值，确保不同请求间该参数值唯一，避免当调用API超时或服务器内部错误时，客户端多次重试导致重复性操作。取值：仅支持ASCII字符，且不能超过64个字符。

返回数据

名称	类型	示例值	描述
OperationDetails	Array of Struct	-	操作详情，具体请参见下表“ OperationDetails结构 ”。

OperationDetails结构

名称	类型	示例值	描述
InstanceId	String	i-bp67acfmxazb4p****	操作的实例ID。
Error	Struct	-	操作的实例错误信息，具体请参见下表“ Error结构 ” 。

Error结构

名称	类型	示例值	描述
Code	String	InvalidInstance.NotFound	批量操作时具体单个请求失败的错误码，具体请参见下表“ 错误码（批量操作时具体单个请求失败）”。
Message	String	The specified instance does not exist.	批量操作时具体单个请求失败的错误信息，具体请参见下表“ 错误码（批量操作时具体单个请求失败）”。

错误码（批量操作时具体单个请求失败）

错误码	错误信息	描述
InvalidInstance.NotFound	The specified instance does not exist.	指定的实例不存在。
FlowLimitExceeded	You've reach the limit on request rate of resources.	您已超过资源请求限速。
LimitExceeded.MaximumIamRoles	You've reached the limit on the number of IamRoles that can be associated with the instance.	您已达到可绑定角色上限。

请求示例

GET /?Action=AssociateInstancesIamRole&Version=2020-04-01&InstanceIds.1=i-3tiefmkskq3vj0******&IamRoleName=EcsTestRole HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
Service: ecs

返回示例

Response
{
    "ResponseMetadata": {
        "RequestId": "2021110417394001022514606307D7****",
        "Action": "AssociateInstancesIamRole",
        "Version": "2020-04-01",
        "Service": "ecs",
        "Region": "cn-beijing"
    },
    "Result": {
        "OperationDetails": [
            {
                "InstanceId": "i-ahipakt2gcg95jpv****",
                "Error": null
            },
            {
                "InstanceId": "i-ahipakt2hgg95k5c****",
                "Error": {
                    "Code": "InvalidInstance.NotFound",
                    "Message": "The specified instance does not exist."
                }
            }
        ]
    }
}

错误码

HttpCode	错误码	错误信息	描述
400	InvalidArgument	The specified argument is invalid.	指定的参数不合法。
400	InvalidCount.Malformed	The specified count is malformed.	指定的实例数目不合法。
400	IdempotentParameterMismatch	The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.	幂等参数不一致。
400	InvalidClientToken.Malformed	The specified ClientToken is malformed.	指定的ClientToken不合法。
404	InvalidIamRole.NotFound	The specified IAMRoleName does not exist.	指定的IAM角色未查询到。
412	IdempotentProcessing	The request uses the same client token as a previous one that is still in process.	先前的幂等请求仍在处理中，请稍后重试。
500	InternalError	An internal error has occurred.	内部错误，请重试。如果多次尝试失败，请提交工单。

请求参数

返回数据

OperationDetails结构

请求示例

返回示例

错误码