tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

EnableRestProxy

Last updated: 2024-07-24 10:20:35

    1. API Description

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

    This API is used to enable the RESTful API.

    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: EnableRestProxy.
    Version Yes String Common Params. The value used for this API: 2019-08-23.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    ClusterId Yes String The value is the same as appid.

    3. Output Parameters

    Parameter Name Type Description
    RestProxyStatus Integer RestProxy status. Valid values: 0 (disabled), 1 (enabling), 2 (enabled), 3 (disabling).
    TaskId String TaskId is in the format of AppInstanceId-taskId, used to identify tasks of different clusters.
    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 Enabling the RESTful API

    This example shows how to enable the RESTful API by specifying the ClusterId.

    Input Example

    https://tcaplusdb.tencentcloudapi.com/?Action=EnableRestProxy
&ClusterId=5674209986
&<Common request parameters>

    Output Example

    {
    "Response": {
        "RestProxyStatus": 1,
        "RequestId": "request-xxx123",
        "TaskId": "838418134-44"
    }
}

    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
    AuthFailure.UnauthorizedOperation API operation authentication error.
    FailedOperation Operation failed.
    InternalError Internal error.
    InvalidParameter Invalid parameter.
    InvalidParameterValue Incorrect parameter value.
    InvalidParameterValue.InvalidAppName Invalid cluster name
    InvalidParameterValue.InvalidClusterName Invalid cluster name.
    InvalidParameterValue.InvalidTableGroupName Invalid table group name.
    InvalidParameterValue.InvalidTimeValue Invalid time format.
    InvalidParameterValue.InvalidZoneName Invalid AZ name
    InvalidParameterValue.UnsupportIdlType Unsupported application data description type.
    ResourceNotFound The resource does not exist.
    UnsupportedOperation Unsupported operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy