Help Center/ Relational Database Service/ API Reference/ API v3 (Recommended)/ Instance Diagnosis/ Obtaining the Number of Instances After Diagnosis
Updated on 2024-06-07 GMT+08:00

Obtaining the Number of Instances After Diagnosis

Function

This API is used to obtain the number of instances after diagnosis.

  • Before calling an API, you need to understand the API in Authentication.

URI

  • URI format

    GET /v3/{project_id}/instances/diagnosis

  • Parameter description
    Table 1 Parameter description

    Name

    Mandatory

    Description

    project_id

    Yes

    Project ID of a tenant in a region.

    To obtain it, refer to Obtaining a Project ID.

    Table 2 Request parameters

    Parameter

    Mandatory

    Type

    Description

    engine

    Yes

    String

    Engine type.

    Enumerated values:

    • mysql
    • postgresql
    • sqlserver

Request

  • Request parameters

    None

  • URI example

    GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/diagnosis?engine=sqlserver

Response

  • Normal response
    Table 3 Parameter description

    Name

    Type

    Description

    diagnosis

    Array of objects

    Diagnosis details.

    For details, see Table 4.

    Table 4 diagnosis field data structure description

    Name

    Type

    Description

    name

    String

    Diagnosis item.

    count

    Integer

    Number of instances.

  • Example normal response
    { 
       "diagnosis" : [ { 
         "name" : "high_pressure", 
         "count" : 1 
       }, { 
         "name" : "lock_wait", 
         "count" : 2 
       } ] 
     }
  • Abnormal response

    For details, see Abnormal Request Results.

Status Code

Error Code

For details, see Error Codes.