tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeSubscribeCheckJob

Last updated: 2024-12-04 15:34:41

1. API Description

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

This API is used to query the results of a subscription check task.

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: DescribeSubscribeCheckJob.
Version Yes String Common Params. The value used for this API: 2021-12-06.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
SubscribeId Yes String Data subscription instance ID

3. Output Parameters

Parameter Name Type Description
SubscribeId String Subscription instance ID
Message String Failure or error prompts, success signals 'success'.
Note: This field may return null, indicating that no valid values can be obtained.
Status String Job running status. Valid values: running, failed, success.
Progress Integer Current overall progress. Value range: 0-100.
StepAll Integer Total check steps
StepNow Integer Current step in execution
Steps Array of SubscribeCheckStepInfo Running status of each stepNote: This field may return null, indicating that no valid values can be obtained.
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 Querying the results of a subscription check task

This example shows you how to query the results of a subscription check task.

Input Example

POST / HTTP/1.1
Host: dts.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSubscribeCheckJob
<Common Request Parameters>

{
    "SubscribeId": "subs-l4d3a7izai"
}

Output Example

{
    "Response": {
        "Message": "success",
        "Progress": 100,
        "RequestId": "b048a800-f2fe-11ed-a211-5df19a912eab",
        "Status": "success",
        "StepAll": 5,
        "StepNow": 5,
        "Steps": [
            {
                "Errors": [],
                "Percent": 100,
                "Status": "finished",
                "StepId": "ConnectDBCheck",
                "StepName": "Database Connection Check",
                "StepNo": 1,
                "Warnings": []
            },
            {
                "Errors": [],
                "Percent": 100,
                "Status": "finished",
                "StepId": "OptimizeCheck",
                "StepName": "Peripheral Check",
                "StepNo": 2,
                "Warnings": []
            },
            {
                "Errors": [],
                "Percent": 100,
                "Status": "finished",
                "StepId": "VersionCheck",
                "StepName": "Version Check",
                "StepNo": 3,
                "Warnings": []
            },
            {
                "Errors": [],
                "Percent": 100,
                "Status": "finished",
                "StepId": "SrcPrivilegeCheck",
                "StepName": "Source Instance Permission Check",
                "StepNo": 4,
                "Warnings": [
                    {
                        "HelpDoc": "",
                        "Message": "We do not require permissions to modify your source data, please cancel them. For example, your authorization: GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, RELOAD, PROCESS, REFERENCES, INDEX, ALTER, SHOW DATABASES, CREATE TEMPORARY TABLES, LOCK TABLES, EXECUTE, REPLICATION SLAVE, REPLICATION CLIENT, CREATE VIEW, SHOW VIEW, CREATE ROUTINE, ALTER ROUTINE, CREATE USER, EVENT, TRIGGER, CREATE TABLESPACE, CREATE ROLE, DROP ROLE ON *.* TO `root`@`%` WITH GRANT OPTION,GRANT APPLICATION_PASSWORD_ADMIN,ROLE_ADMIN,SHOW_ROUTINE,XA_RECOVER_ADMIN ON *.* TO `root`@`%` WITH GRANT OPTION. Please refer to https://www.tencentcloud.com/document/product/571/52412?from_cn_redirect=1."
                    }
                ]
            },
            {
                "Errors": [],
                "Percent": 100,
                "Status": "finished",
                "StepId": "BinlogParamCheck",
                "StepName": "Binlog Parameter Check",
                "StepNo": 5,
                "Warnings": []
            }
        ],
        "SubscribeId": "subs-9jyki7hniw"
    }
}

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 The CAM signature/authentication information is incorrect.
AuthFailure.AuthFailureError Authentication failed.
FailedOperation Operation failed.
FailedOperation.FailedOperationError The operation failed.
InternalError An internal error occurred.
InternalError.InternalErrorError An internal error occurred.
InvalidParameter The parameter is incorrect.
InvalidParameter.InvalidParameterError The parameter is invalid.
InvalidParameterValue Invalid parameter value.
InvalidParameterValue.InvalidParameterValueError The parameter is invalid.
OperationDenied The operation was denied.
OperationDenied.OperationDeniedError The operation was denied.
ResourceNotFound The resource does not exist.
ResourceNotFound.ResourceNotFoundError The resource was not found.
UnauthorizedOperation The operation is unauthorized.
UnauthorizedOperation.UnauthorizedOperationError The operation is unauthorized.
UnsupportedOperation The operation is not supported.
UnsupportedOperation.UnsupportedOperationError The operation is not supported.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy