调用CreateServiceLinkedRole创建服务关联角色-阿里云帮助中心

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	CreateServiceLinkedRole	要执行的操作。取值：CreateServiceLinkedRole。
ServiceName	String	是	polardb.aliyuncs.com	服务名称。具体信息，请参见支持服务关联角色的云服务。
CustomSuffix	String	否	Example	角色名称后缀。角色名称（含后缀）的总长度为1~64个字符，可包含英文字母、数字、半角句号（.）和短划线（-）。例如：假设后缀为`Example`，则角色名称为`ServiceLinkedRoleName_Example`，且最大长度不能超过64个字符。
Description	String	否	Service Linked Role for PolarDB. PolarDB will use this role to access your resources in other services.	服务关联角色描述。只有允许自定义后缀的服务关联角色才能填写角色描述，否则，角色描述将使用预设值且不能修改。长度为1~1024个字符。

关于公共请求参数的详情，请参见公共参数。

返回数据


名称	类型	示例值	描述
Role	Object		角色信息。
AssumeRolePolicyDocument	String	{\"Statement\":[{\"Action\":\"sts:AssumeRole\",\"Effect\":\"Allow\",\"Principal\":{\"Service\":[\"polardb.aliyuncs.com\"]}}],\"Version\":\"1\"}	角色的信任策略内容。
RolePrincipalName	String	AliyunServiceRoleForPolarDB@role.test.onaliyunservice.com	带域名后缀的角色名称。
Description	String	Service Linked Role for PolarDB. PolarDB will use this role to access your resources in other services.	角色描述。
RoleName	String	AliyunServiceRoleForPolarDB	角色名称。
CreateDate	String	2020-06-30T08:14:16Z	角色创建时间（UTC时间）。
Arn	String	acs:ram::177242285274****:role/aliyunserviceroleforpolardb	角色的资源描述符。
RoleId	String	32833240981067****	角色ID。
IsServiceLinkedRole	Boolean	true	是否为服务关联角色。取值： true：是服务关联角色。 false：不是服务关联角色。
RequestId	String	FE58D7CF-03BC-432A-B42D-BC3390C8C2E1	请求ID。

示例

请求示例

https://resourcemanager.aliyuncs.com/?Action=CreateServiceLinkedRole
&ServiceName=polardb.aliyuncs.com
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateServiceLinkedRoleResponse>
    <Role>
        <RoleName>AliyunServiceRoleForPolarDB</RoleName>
        <Description>Service Linked Role for PolarDB. PolarDB will use this role to access your resources in other services.</Description>
        <AssumeRolePolicyDocument>{"Statement":[{"Action":"sts:AssumeRole","Effect":"Allow","Principal":{"Service":["polardb.aliyuncs.com"]}}],"Version":"1"}</AssumeRolePolicyDocument>
        <Arn>acs:ram::177242285274****:role/aliyunserviceroleforpolardb</Arn>
        <IsServiceLinkedRole>true</IsServiceLinkedRole>
        <CreateDate>2020-06-30T08:14:16Z</CreateDate>
        <RoleId>32833240981067****</RoleId>
        <RolePrincipalName>AliyunServiceRoleForPolarDB@role.test.onaliyunservice.com</RolePrincipalName>
    </Role>
    <RequestId>FE58D7CF-03BC-432A-B42D-BC3390C8C2E1</RequestId>
</CreateServiceLinkedRoleResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Role" : {
    "RoleName" : "AliyunServiceRoleForPolarDB",
    "Description" : "Service Linked Role for PolarDB. PolarDB will use this role to access your resources in other services.",
    "AssumeRolePolicyDocument" : "{\"Statement\":[{\"Action\":\"sts:AssumeRole\",\"Effect\":\"Allow\",\"Principal\":{\"Service\":[\"polardb.aliyuncs.com\"]}}],\"Version\":\"1\"}",
    "Arn" : "acs:ram::177242285274****:role/aliyunserviceroleforpolardb",
    "IsServiceLinkedRole" : true,
    "CreateDate" : "2020-06-30T08:14:16Z",
    "RoleId" : "32833240981067****",
    "RolePrincipalName" : "AliyunServiceRoleForPolarDB@role.test.onaliyunservice.com"
  },
  "RequestId" : "FE58D7CF-03BC-432A-B42D-BC3390C8C2E1"
}

错误码


HttpCode	错误码	错误信息	描述
400	InvalidParameter.CustomSuffix.NotAllowed	Custom suffix is not allowed for this Service Linked Role.	该服务关联角色不支持自定义后缀。
400	InvalidParameter.CustomSuffix.InvalidChars	The parameter CustomSuffix contains invalid characters.	参数CustomSuffix包含无效字符。
400	InvalidParameter.CustomSuffix.Length	The maximum length of the parameter CustomSuffix is exceeded.	参数CustomSuffix长度超限。
400	InvalidParameter.Description.Length	The maximum length of the description is exceeded. It must not exceed 1024 characters.	描述长度超限。最大不得超过1024个字符。
404	EntityNotExist.Service	The service does not exist.	该服务不存在。
409	EntityAlreadyExists.Role	The role already exists.	角色已存在。
409	LimitExceeded.Role	The maximum number of roles is exceeded.	角色数量超出限制。

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