tencent cloud

All product documents
TencentDB for DBbrain
DocumentationTencentDB for DBbrainAPI DocumentationDBbrain APIs 2019-10-16Other APIsDescribeDiagDBInstances
DescribeDiagDBInstances
Download PDF
Last updated: 2024-11-19 21:55:26
DescribeDiagDBInstances
Last updated: 2024-11-19 21:55:26
Download PDF

1. API Description

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

This API is used to obtain the instance information list. Select Guangzhou for Region.

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: DescribeDiagDBInstances.
Version Yes String Common Params. The value used for this API: 2019-10-16.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
IsSupported Yes Boolean Whether it is an instance supported by DBbrain. It is fixed to “true”.
Product Yes String Service type. Valid values: mysql (TencentDB for MySQL), cynosdb (TDSQL-C for MySQL). Default value: mysql.
Offset Yes Integer Pagination parameter indicating the offset.
Limit Yes Integer Pagination parameter indicating the number of entries for each page.
InstanceNames.N No Array of String Query by instance name.
InstanceIds.N No Array of String Query by instance ID.
Regions.N No Array of String Query by region.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Total Number of Instances
DbScanStatus Integer Status of all instance inspection. 0: all instance inspection enabled, 1: all instance inspection disabled
Items Array of InstanceInfo Instance related information
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 instance information list

This example shows you how to obtain the instance information list. You can query instance related information by instance ID, instance name, and region.

Input Example

https://dbbrain.intl.tencentcloudapi.com/?Action=DescribeDiagDBInstances
&IsSupported=true
&Offset=0
&Limit=50
&Product=mysql
&<common request parameters>

Output Example

{
    "Response": {
        "TotalCount": 2,
        "DbScanStatus": 1,
        "Items": [
            {
                "GroupName": “4 regions as a group”,
                "EventCount": 0,
                "Memory": 4000,
                "Product": "MySQL",
                "Cpu": 2,
                "Source": "TENCENT_CLOUD",
                "UniqSubnetId": "subnet-test",
                "DeployMode": "CUSTOM",
                "InstanceType": 1,
                "AuditRunningStatus": "normal",
                "Status": 1,
                "EngineVersion": "5.6",
                "InstanceId": "cdb-test",
                "Vport": 63492,
                "InitFlag": 1,
                "TaskStatus": 0,
                "UniqVpcId": "vpc-fstest",
                "GroupId": "dg-0ttest",
                "InstanceName": “long-term monitoring”
                "HealthScore": 100,
                "InstanceConf": {
                    "OverviewDisplay": "Yes",
                    "DailyInspection": "Yes"
                },
                "AuditPolicyStatus": "UNBOUND",
                "Volume": 100,
                "DeadlineTime": "2021-02-25 16:33:26",
                "SecAuditStatus": "ON",
                "Region": "ap-guangzhou",
                "Vip": "10.5.0.9",
                "IsSupported": true
            }
        ],
        "RequestId": "b2d08895-1cfe-48bc-b7f7-87fd7cb5d6f1"
    }
}

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 Error with CAM signature/authentication.
FailedOperation Operation failed.
InternalError Internal error.
InvalidParameter Incorrect parameter.
InvalidParameterValue Incorrect parameter value.
MissingParameter Missing parameter.
OperationDenied.UserHasNoStrategy Error with CAM authentication.
RequestLimitExceeded The number of requests exceeds the frequency limit.
UnknownParameter Unknown parameter.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon