tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeMigrateDBInstances

Last updated: 2024-12-04 15:35:06

    1. API Description

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

    This API is used to query migratable database instances.

    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: DescribeMigrateDBInstances.
    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.
    DatabaseType Yes String Database type, such as mysql.
    MigrateRole No String Specifies whether the instance is the migration source or target. Valid values: src (source); dts (target).
    InstanceId No String Database instance ID
    InstanceName No String Database instance name
    Limit No Integer Number of results to be returned
    Offset No Integer Offset
    AccountMode No String The account to which the resource belongs. Valid values: empty or self (the current account); other (another account).
    TmpSecretId No String ID of the temporary key, which is required if the operation is performed across accounts.
    TmpSecretKey No String Key of the temporary key, which is required if the operation is performed across accounts.
    TmpToken No String Temporary token, which is required if the operation is performed across accounts.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Number of eligible items
    Note: This field may return null, indicating that no valid values can be obtained.
    Instances Array of MigrateDBItem Instance list
    Note: 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 list of migrated instances

    This example shows you how to query the list of migrated instances.

    Input Example

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

{
    "InstanceId": "cdb-eur39922",
    "DatabaseType": "mysql",
    "MigrateRole": "src"
}

    Output Example

    {
    "Response": {
        "TotalCount": 1,
        "RequestId": "cafebabe-848392-di98382-dfu9832",
        "Instances": []
    }
}

    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.
    AuthFailure.UnauthorizedOperationError The current user is not allowed to perform this operation as the authentication failed.
    DryRunOperation.DryRunOperationError DryRun operation, which means an unnecessary DryRun parameter is passed in yet the request will still be successful.
    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.InvalidParameterValueError The parameter is invalid.
    LimitExceeded.LimitExceededError The quantity exceeds the limit.
    MissingParameter The parameter is missing.
    MissingParameter.MissingParameterError The parameter is lost.
    OperationDenied.OperationDeniedError The operation was denied.
    RequestLimitExceeded.RequestLimitExceededError The number of requests exceeds the limit.
    ResourceInUse.ResourceInUseError The resource is being used.
    ResourceInsufficient.ResourceInsufficientError The resources are insufficient.
    ResourceNotFound The resource does not exist.
    ResourceNotFound.BizResourceNotFoundError The resource was not found.
    ResourceNotFound.ResourceNotFound The instance was not found.
    ResourceNotFound.ResourceNotFoundError The resource was not found.
    ResourceUnavailable.ResourceUnavailableError The resource is unavailable.
    ResourcesSoldOut.ResourcesSoldOutError The resources have been sold out.
    UnauthorizedOperation The operation is unauthorized.
    UnauthorizedOperation.PermissionDenied The operation is unauthorized.
    UnauthorizedOperation.UnauthorizedOperationError The operation is unauthorized.
    UnknownParameter The parameter is unknown.
    UnknownParameter.UnknownParameterError The parameter is unknown.
    UnsupportedOperation The operation is not supported.
    UnsupportedOperation.UnsupportedOperationError The operation is not supported.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy