tencent cloud

APIs

ModifyAccessPolicy

Download
Mode fokus
Ukuran font
Terakhir diperbarui: 2026-08-03 10:13:34

1. API Description

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

This API is used to modify the public IP allowlist of an instance.

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: ModifyAccessPolicy.
Version Yes String Common Params. The value used for this API: 2019-08-19.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
InstanceId Yes String

Instance ID.

RouteId Yes Integer

Route ID

IpWhitelist.N No Array of IpWhitelistDTO

Public Network IP Whitelist Configuration

Default if not passed: delete all

3. Output Parameters

Parameter Name Type Description
Result String

Result of public IP allowlist modification

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 the Public IP Allowlist Configuration of an Instance

Modify the public IP allowlist configuration of an instance

Input Example

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

{
    "InstanceId": "ckafka-ay3z77qe",
    "RouteId": 137946,
    "IpWhitelist": [
        {
            "CidrBlock": "127.0.0.1",
            "PolicyDescription": "test-description"
        }
    ]
}

Output Example

{
    "Response": {
        "Result": "Succeed",
        "RequestId": "0ca44380-3c17-4755-9564-f48de2e01760"
    }
}

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
AuthFailure CAM signature/authentication error.
FailedOperation Operation failed.
InternalError Internal error.
InvalidParameter Invalid parameter.
InvalidParameterValue Invalid parameter value.
InvalidParameterValue.InstanceNotExist The instance does not exist.
InvalidParameterValue.NotAllowedEmpty The parameter is required.
InvalidParameterValue.WrongAction The value of the Action parameter is incorrect.
MissingParameter Missing parameter
OperationDenied Operation denied.
RegionError Region error
RequestLimitExceeded The number of requests exceeds the frequency limit.
ResourceNotFound The resource does not exist.
ResourceUnavailable The resource is unavailable.
UnauthorizedOperation Unauthorized operation.
UnknownParameter Unknown parameter error.
UnsupportedOperation Unsupported operation.

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan