AssociateInstancesIamRole - 绑定实例IAM角色--云服务器-火山引擎

文档中心

立即注册

导航

云服务器

AssociateInstancesIamRole - 绑定实例IAM角色

最近更新时间：2024.10.28 17:36:25首次发布时间：2022.07.01 09:22:08

调用 AssociateInstancesIamRole 接口为一台或多台实例绑定IAM角色。

请求说明

执行该操作前，您需要先拥有一个信任身份为 云服务器 的IAM角色，具体操作请参见角色管理。
调用该接口时，一台实例仅允许用户绑定一个IAM角色（不包含服务关联的角色）。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

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

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

说明

仅当请求参数输入不合法时提示下文中的接口错误码。若请求参数输入无误，将不会提示接口错误码，且接口的返回状态码将为200，但这并不代表对所有实例的操作均已成功，单个实例的操作结果请参见如下返回参数中的信息。

参数	类型	示例值	描述
OperationDetails	Array of Object	--	操作详情。

请求示例

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

返回示例

{
    "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."
                }
            }
        ]
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidArgument	The specified argument is invalid.	指定的参数不合法。
400	InvalidCount.Malformed	The specified count is malformed.	指定的参数Count不合法。
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.	内部错误，请重试。如果多次尝试失败，请提交工单。