tencent cloud

Feedback

UpdateCustomPolicyForRoleConfiguration

Last updated: 2024-11-27 21:25:48

1. API Description

Domain name for API request: organization.intl.tencentcloudapi.com.

This API is used to modify a custom policy for permission configurations.

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: UpdateCustomPolicyForRoleConfiguration.
Version Yes String Common Params. The value used for this API: 2021-03-31.
Region No String Common Params. This parameter is not required.
ZoneId Yes String Space ID.
RoleConfigurationId Yes String Permission configuration ID.
CustomPolicyName Yes String Permission policy name, which contains up to 32 characters.
NewCustomPolicyDocument No String Custom policy content, which contains up to 4096 characters. When RolePolicyType is Inline, this parameter must be configured. For details, see the permission policy syntax and structure.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Modifying a Custom Policy for Permission Configurations

This example shows you how to modify a custom policy for permission configurations.

Input Example

POST / HTTP/1.1
Host: organization.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateCustomPolicyForRoleConfiguration
<Common request parameters>



{
    "ZoneId": "z-fdk3o32kqw",
    "RoleConfigurationId": "rc-sin23wj29s",
    "CustomPolicyName": "test",
    "NewCustomPolicyDocument": "{\"statement\":{\"action\":[\"name/cvm:*\",\"name/vpc:*\",\"name/cos:*\",\"name/cmqtopic:*\",\"name/cmqqueue:*\"],\"effect\":\"allow\",\"resource\":\"*\"},\"version\":\"2.0\"}"
}

Output Example

{
    "Response": {
        "RequestId": "e297543a-80de-4039-83c8-9d324545"
    }
}

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.DBOperationError SQL execution error.
FailedOperation.IdentityCenterNotOpen The CIC service is not enabled.
FailedOperation.ZoneIdNotExist The user zoneId of the CIC service does not exist.
InvalidParameter.PolicyDocumentEmpty The custom policy content cannot be empty.
InvalidParameter.PolicyTypeError Errors occurred when the policy type is modified. Only custom policies can be modified.
InvalidParameter.RoleConfigurationNotExist The permission configuration does not exist.
InvalidParameter.RolePolicyNotExist The policy does not exist.