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

Obtaining the Number of Instances After Diagnosis

Function

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

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
  • If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

rds:instance:listAll

read

-

-

rds:instance:list

-

URI

  • URI format

    GET /v3/{project_id}/instances/diagnosis

  • Parameter description
    Table 1 Parameters

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Definition

    Project ID of a tenant in a region.

    To obtain the value, see Obtaining a Project ID.

    Constraints

    N/A

    Range

    N/A

    Default Value

    N/A

    Table 2 Request parameters

    Parameter

    Mandatory

    Type

    Description

    engine

    Yes

    String

    Definition

    Engine type.

    Constraints

    N/A

    Range

    • mysql
    • postgresql
    • sqlserver

    Default Value

    N/A

Request

  • Request parameters

    None

  • URI example

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

Response

  • Normal response
    Table 3 Parameters

    Parameter

    Type

    Description

    diagnosis

    Array of objects

    Definition

    Diagnosis details.

    For details, see Table 4.

    Table 4 diagnosis field data structure description

    Parameter

    Type

    Description

    name

    String

    Definition

    Diagnosis item.

    Range

    N/A

    count

    Integer

    Definition

    Number of instances.

    Range

    N/A

  • 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.