サービスにリンクされたロールを作成します。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須/任意 例 説明
Action String 必須 CreateServiceLinkedRole

実行する操作です。 値を CreateServiceLinkedRole に設定します。

ServiceName String 必須 polardb.aliyuncs.com

サービスの名前です。

サービス名の詳細については、「サービスにリンクされたロールをサポートする Alibaba Cloud サービス」をご参照ください。

CustomSuffix String 任意 Example

ロール名のサフィックスです。

ロール名 (サフィックスを含む) は 1～64 文字で、英数字、ピリオド (.)、ハイフン (-) を使用できます。

たとえば、サフィックスが Exampleの場合は、ロール名は以下のようになります： ServiceLinkedRoleName_Example.

説明 String 任意 PolarDB のサービスにリンクされたロールです。 PolarDB は、このロールを使用して他のサービスのリソースにアクセスします。

サービスにリンクされたロールの説明です。

サフィックスのカスタマイズに対応したサービスにリンクされたロールには、このパラメーターを設定する必要があります。 設定しない場合、プリセット値が使用され、変更できません。

説明は 1～1024 文字である必要があります。

共通リクエストパラメーターの詳細については、「共通パラメーター」をご参照ください。

レスポンスパラメーター

パラメーター データ型 例 説明
ロール オブジェクト

ロールに関する情報です。

AssumeRolePolicyDocument String {\"Statement\":[{\"Action\":\"sts:AssumeRole\",\"Effect\":\"Allow\",\"Principal\":{\"Service\":[\"polardb.aliyuncs.com\"]}}],\"Version\":\"1\"}

ロールの信頼ポリシーのドキュメントです。

RolePrincipalName String AliyunServiceRoleForPolarDB@role.test.onaliyunservice.com

ドメイン名をサフィックスとして使用するロール名です。

説明 String PolarDB のサービスにリンクされたロールです。 PolarDB は、このロールを使用して他のサービスのリソースにアクセスします。

ロールの説明です。

RoleName String AliyunServiceRoleForPolarDB

ロールの名前です。

CreateDate String 2020-06-30T08:14:16Z

ロールが作成された時刻です。 時刻は UTC で表示されます。

Arn String acs:ram::177242285274****:role/aliyunserviceroleforpolardb

ロールの Alibaba Cloud Resource Name (ARN) です。

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
&<Common request parameters>

正常に処理された場合のレスポンス例

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"
}

エラーコード

HTTP ステータスコード エラーコード エラーメッセージ 説明
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. 説明の長さが上限を超えた場合に返されるエラーメッセージです。 説明は 1～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. ロールの最大数に達した場合に返されるエラーメッセージです。

エラーコードの一覧については、「サービスエラーコード」をご参照ください。