tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

DescribeDBSyncMode

最后更新时间：2023-09-05 09:56:35

1. API Description

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

This API is used to query the sync mode of a TencentDB instance.

A maximum of 200 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: DescribeDBSyncMode.
Version Yes String Common Params. The value used for this API: 2018-04-11.
Region No String Common Params. This parameter is not required for this API.
InstanceId Yes String ID of an instance for which to modify the sync mode. The ID is in the format of dcdbt-ow728lmc.

3. Output Parameters

Parameter Name Type Description
SyncMode Integer Sync mode. 0: async; 1: strong sync; 2: downgradable strong sync
IsModifying Integer Whether a modification is in progress. 1: yes; 0: no.
CurrentSyncMode Integer Current sync mode. Valid values: 0 (async), 1 (sync).
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the sync mode of a TencentDB instance

Input Example

https://dcdb.tencentcloudapi.com/?Action=DescribeDBSyncMode
&InstanceId=dcdbt-avw0207d
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "901bd41c-08a2-4001-8364-5a63f32056ae",
        "SyncMode": 0,
        "CurrentSyncMode": 0,
        "IsModifying": 1
    }
}

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.OssOperationFailed Failed to request the backend API.
InternalError.CamAuthFailed CAM authentication request failed.
InternalError.DbOperationFailed Failed to query the database.
InternalError.GetInstanceDetailFailed Failed to get the instance details.
InternalError.InnerSystemError Internal system error.
InvalidParameter.GenericParameterError An error occurred while verifying parameter validity.
InvalidParameter.InstanceNotFound Failed to find the requested instance.
ResourceUnavailable.InstanceStatusAbnormal Incorrect database instance status. Operations are not allowed.
UnauthorizedOperation.PermissionDenied You have no permission to manipulate this API or resource.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
隐私条款服务条款缓存条款