tencent cloud

Feedback

CreateServiceLinkedRole

Last updated: 2023-03-15 10:25:05

1. API Description

Domain name for API request: cam.tencentcloudapi.com.

This API is used to create a service-linked role.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: CreateServiceLinkedRole.
Version Yes String Common Params. The value used for this API: 2019-01-16.
Region No String Common Params. This parameter is not required for this API.
QCSServiceName.N Yes Array of String Authorized service, i.e., Tencent Cloud service entity with this role attached.
CustomSuffix No String Custom suffix. A string you provide, which is combined with the service-provided prefix to form the complete role name.
Description No String Role description.
Tags.N No Array of RoleTags Tags bound to the role.

3. Output Parameters

Parameter Name Type Description
RoleId String Role ID
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Input Example

https://cam.tencentcloudapi.com/?Action=CreateServiceLinkedRole
&QCSServiceName.0=ccs.qcloud.com
&CustomSuffix=forTest
&Description=ccsLinkedRole
&<Common request parameters>

Output Example

{
    "Response": {
        "RoleId": "4611686018427411525",
        "RequestId": "c3da1c1c-df35-467d-9335-99c68d993e0a"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation.TagResourceFailed Failed to bind the tag.
InternalError.SystemError Internal error.
InvalidParameter.ConditionContentError The condition content in the policy syntax is incorrect.
InvalidParameter.ConditionError condition field of policy document invalid.
InvalidParameter.ConditionTypeError The condition operator in the policy syntax is incorrect.
InvalidParameter.DescriptionLengthOverlimit The input parameter description cannot exceed 300 bytes in length.
InvalidParameter.ParamError Invalid input parameter.
InvalidParameter.PolicyIdNotExist Policy ID does not exist.
InvalidParameter.PrincipalError principal field of policy document invalid.
InvalidParameter.PrincipalQcsError Incorrect PrincipalQcsc.
InvalidParameter.PrincipalQcsNotExist PrincipalQcs does not exist.
InvalidParameter.PrincipalServiceNotExist PrincipalService does not exist.
InvalidParameter.RoleNameError Role name invalid.
InvalidParameter.RoleNameInUse A role with the same name already exists.
InvalidParameter.TagLimitExceeded The tag limit has been exceeded.
InvalidParameter.TagParamError Incorrect tag parameter.