GetServiceLinkedRoleTemplate - Resource Access Management

Retrieves the template of a service-linked role.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
ServiceName	string	No	The cloud service name. For more information, see the Cloud service identity column in Cloud services that support service-linked roles.	polardb.aliyuncs.com

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368
ServiceLinkedRoleTemplate	object	The service-linked role template.
MultipleRolesAllowed	boolean	Indicates whether multiple roles are supported. Valid values: true: Multiple roles are supported. false: Multiple roles are not supported.	false
RoleDescriptions	object
RoleDescription	array<object>	The role descriptions.
	object	The role descriptions.
Description	string	The role description.	Service Linked Role for PolarDB. PolarDB will use this role to access your resources in other services.
Language	string	The language type. Valid values: zh-CN: Chinese. en: English. ja: Japanese.	en
RoleNamePrefix	string	The prefix of the role name.	AliyunServiceRoleForPolarDB
ServiceName	string	The cloud service name.	polardb.aliyuncs.com
SystemPolicyName	string	The name of the system policy attached to the role.	AliyunServiceRolePolicyForPolarDB

Examples

Success response

JSON format

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "ServiceLinkedRoleTemplate": {
    "MultipleRolesAllowed": false,
    "RoleDescriptions": {
      "RoleDescription": [
        {
          "Description": "Service Linked Role for PolarDB. PolarDB will use this role to access your resources in other services.",
          "Language": "en"
        }
      ]
    },
    "RoleNamePrefix": "AliyunServiceRoleForPolarDB",
    "ServiceName": "polardb.aliyuncs.com",
    "SystemPolicyName": "AliyunServiceRolePolicyForPolarDB"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.