tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

UpdateRoleDescription

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

1. API Description

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

This API (UpdateRoleDescription) is used to modify the description of a role.

A maximum of 3 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: UpdateRoleDescription.
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.
Description Yes String Role description
RoleId No String Role ID, used to specify a role. Input either RoleId or RoleName
RoleName No String Role name, used to specify a role. Input either RoleId or RoleName

3. Output Parameters

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

4. Example

Example1 Modifying a role description

Input Example

https://cam.tencentcloudapi.com/?Action=UpdateRoleDescription
&RoleId=4611686018427731422
&Description=abc234
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "405af400-30ec-4c78-8955-ef4da843bde2"
    }
}

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
InternalError.SystemError Internal error.
InvalidParameter.DescriptionLengthOverlimit The input parameter description cannot exceed 300 bytes in length.
InvalidParameter.ParamError Invalid input parameter.
InvalidParameter.RoleNotExist Role does not exist.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy