tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeDMSDatabase

Last updated: 2024-08-08 15:32:38

1. API Description

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

This API is used to obtain databases in the DMS metadata module.

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: DescribeDMSDatabase.
Version Yes String Common Params. The value used for this API: 2021-01-25.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
Name No String Database name
SchemaName No String Schema name
Pattern No String Match rules

3. Output Parameters

Parameter Name Type Description
Name String Database name
Note: This field may return null, indicating that no valid values can be obtained.
SchemaName String Schema name
Note: This field may return null, indicating that no valid values can be obtained.
Location String Storage address
Note: This field may return null, indicating that no valid values can be obtained.
Asset Asset Data object
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 Obtaining Databases in the DMS Metadata Module

Input Example

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

{
    "Name": "Name1",
    "SchemaName": "Schema1",
    "Pattern": "*"
}

Output Example

{
    "Response": {
        "Name": "abc",
        "SchemaName": "abc",
        "Location": "abc",
        "Asset": {
            "Id": 0,
            "Name": "abc",
            "Guid": "abc",
            "Catalog": "abc",
            "Description": "abc",
            "Owner": "abc",
            "OwnerAccount": "abc",
            "PermValues": [
                {
                    "Key": "abc",
                    "Value": "abc"
                }
            ],
            "Params": [
                {
                    "Key": "abc",
                    "Value": "abc"
                }
            ],
            "BizParams": [
                {
                    "Key": "abc",
                    "Value": "abc"
                }
            ],
            "DataVersion": 0,
            "CreateTime": "2020-09-22T00:00:00+00:00",
            "ModifiedTime": "2020-09-22T00:00:00+00:00",
            "DatasourceId": 0
        },
        "RequestId": "abc"
    }
}

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
InternalError An internal error occurred.
InvalidParameter The parameter is incorrect.
ResourceNotFound The resource does not exist.
UnauthorizedOperation Unauthorized operation.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy