doc-exports/docs/rds/api-ref/rds_17_0002.html

Obtaining the Result of a Specific Diagnosis Item

Function

This API is used to obtain the result of a specific diagnosis item.

• Before calling an API, you need to understand the API in Authentication.
• Before calling this API, obtain the required region and endpoint.

URI

• URI format

  GET https://{endpoint}/v3/{project_id}/instances/diagnosis/info

• Parameter description

  Table 1 Parameter description

  Name	Mandatory	Description
  project_id	Yes	Specifies the project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID.

  Table 2 Request parameters

  Parameter	Mandatory	Type	Description
  engine	Yes	String	Engine type. Enumerated values: mysql postgresql sqlserver
  diagnosis	Yes	String	Diagnosis item. Enumerated values: high_pressure lock_wait insufficient_capacity slow_sql_frequency disk_performance_cap mem_overrun age_exceed connections_exceed
  offset	No	Integer	Index offset. If offset is set to N, the resource query starts from the N+1 piece of data. The value is 0 by default, indicating that the query starts from the first piece of data. The value must be a number but cannot be a negative number.
  limit	No	Integer	Number of returned results. Default value: 10

Request

• Request parameters

  Table 3 Request header parameters

  Parameter	Mandatory	Type	Description
  X-Auth-Token	Yes	String	Specifies the user token. The user token is a response to the API used to obtain a user token.

• URI example

  GET https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/diagnosis/info?engine=sqlserver&diagnosis=high_pressure&offset=1&limit=10

Response

• Normal response

  Table 4 Parameter description

  Parameter	Type	Description
  diagnosis	String	Diagnosis item. Enumerated values: high_pressure lock_wait insufficient_capacity slow_sql_frequency disk_performance_cap mem_overrun age_exceed connections_exceed
  total_count	Integer	Number of instances.
  instances	Array of objects	Specifies the DB instance ID. For details, see Table 5.

  Table 5 instances field data structure description

  Name	Type	Description
  id	String	Specifies the DB instance ID.

• Example normal response

  { 
    "diagnosis" : "high_pressure", 
    "total_count" : 1, 
    "instances" : [ { 
      "id" : "abd21a25fdedfd6db69721f4b761bc38in04" 
    } ] 
  }

• Abnormal response

  For details, see Abnormal Request Results.

Status Code

• Normal

  200

• Abnormal

  For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Instance Diagnosis