tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

DescribeDiagDBInstances

最后更新时间：2023-10-17 10:51:56

    1. API Description

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

    This API is used to get the instance information list. Please always 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: 2021-05-27.
    Region No String Common Params. This parameter is not required for this API.
    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. Maximum value: 100.
    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 information.
    RequestId String The unique request ID, which is returned for each request. 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 information by instance ID, instance name, and region.

    Input Example

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

    Output Example

    {
    "Response": {
        "TotalCount": 2,
        "DbScanStatus": 1,
        "Items": [
            {
                "GroupName": “Group of four regions”,
                "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.
    LimitExceeded The quota limit is exceeded.
    MissingParameter Missing parameter.
    OperationDenied Operation denied.
    OperationDenied.UserHasNoStrategy Error with CAM authentication.
    RequestLimitExceeded The number of requests exceeds the frequency limit.
    ResourceNotFound The resource does not exist.
    UnauthorizedOperation The operation is unauthorized.
    UnknownParameter Unknown parameter.
    UnsupportedOperation Unsupported operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款