tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

IsolateDBInstances

Last updated: 2024-06-17 14:26:23

    1. API Description

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

    This API is used to isolate an instance.

    A maximum of 100 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: IsolateDBInstances.
    Version Yes String Common Params. The value used for this API: 2017-03-12.
    Region No String Common Params. This parameter is not required for this API.
    DBInstanceIdSet.N Yes Array of String List of instance IDs. Note that currently you cannot isolate multiple instances at the same time. Only one instance ID can be passed in here.

    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 Isolating an instance

    This example shows you how to u200cisolate an instance.

    Input Example

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

{
    "DBInstanceIdSet": [
        "postgres-xxxxxxxx"
    ]
}

    Output Example

    {
    "Response": {
        "RequestId": "d43b2a9f-070c-480b-a0bb-7c210428cfe8"
    }
}

    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 Authentication failed.
    DBError Backend database execution error.
    FailedOperation.DatabaseAccessError Failed to access database management service. Please try again later. If the problem persists, please contact customer service.
    FailedOperation.DatabaseAffectedError Data operation failed. Please contact customer service.
    FailedOperation.FailedOperationError Operation failed. Please try again later.
    FailedOperation.FlowCreateError Failed to create a task. Please try again later. If the problem persists, please contact customer service.
    FailedOperation.GetInstanceByResourceIdError Failed to query the instance information. Please try again later.
    FailedOperation.InvalidAccountStatus The account status is incorrect, so the operation is not allowed.
    FailedOperation.OperateFrequencyLimitedError The operation frequency limit is exceeded. Try again later. If the problem persists, contact customer service.
    FailedOperation.QueryTradeStatusError Failed to query the order status.
    FailedOperation.TradeAccessError Failed to access the billing platform. Please try again later. If the problem persists, please contact customer service.
    FailedOperation.TradeCreateError Failed to request the billing platform to create an order.
    FailedOperation.TradePayOrdersError Failed to request to pay for the order.
    FailedOperation.TradeQueryOrderError Failed to query order information. Please try again later. If the problem persists, please contact customer service.
    FailedOperation.TradeQueryPriceError Failed to query pricing information. Please try again later. If the problem persists, please contact customer service.
    InstanceNotExist The current instance does not exist.
    InternalError.InstanceDataError Failed to access database management service. Please contact customer service.
    InternalError.InternalHttpServerError An exception occurred while executing the request.
    InvalidInstanceStatus Incorrect instance status.
    InvalidParameter Parameter error.
    InvalidParameter.TradeAccessDeniedError Incorrect PID
    InvalidParameterValue Invalid parameter value.
    InvalidParameterValue.DataConvertError Failed to convert data format. Please contact customer service.
    InvalidParameterValue.InvalidParameterValueError Incorrect parameter value
    LimitExceeded Quota limit exceeded.
    LimitOperation Operations are not allowed on the instance.
    MissingParameter Missing parameters.
    OperationDenied.CamDeniedError This operation cannot be performed.
    OperationDenied.DTSInstanceStatusError The target instance failed the status check.
    OperationDenied.InstanceAccessDeniedError You do not have the permission to operate this resource.
    OperationDenied.InstanceStatusLimitError This operation cannot be performed on an instance in this status.
    OperationDenied.InstanceStatusLimitOpError This operation cannot be performed on an instance in this status.
    RegionNotSupported The region is not supported.
    RequestLimitExceeded The number of requests exceeds the frequency limit.
    ResourceNotFound.InstanceNotFoundError The instance does not exist.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy