Querying Historical Diagnosis Records
Function
Query the list of historical diagnosis records.
URI
GET /v2.0/servicerequest/diagnose/records
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
page_size |
No |
Integer |
Specifies the size of a single page. Minimum value: 1 Maximum value: 100 Default value: 10 |
|
page_no |
No |
Integer |
Specifies the page number. Minimum value: 1 Maximum value: 2147483647 Default value: 1 |
|
type |
No |
Integer |
Specifies the task type, for example, 1 indicates an ECS diagnosis task and 2 indicates an RDS diagnosis task. Minimum value: 1 Maximum value: 2 Default value: 1 |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
Specifies the user token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header). Minimum length: 1 Maximum length: 5000 |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Specifies the error code. Minimum length: 0 Maximum length: 32 |
|
error_msg |
String |
Describes the error. Minimum length: 0 Maximum length: 32 |
|
total_count |
Integer |
Specifies the total number of records. Minimum value: 0 Maximum value: 2147483647 |
|
records |
Array of DiagnoseRecordVo objects |
Specifies the list of obtained diagnosis records. Array length: 0 - 2147483647 |
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
String |
Specifies the record ID. Minimum length: 0 Maximum length: 64 |
|
status |
String |
Specifies the diagnosis status. Minimum length: 0 Maximum length: 64 |
|
params |
Map<String,String> |
Specifies the unique properties of a diagnosis task. |
|
domain_id |
String |
Specifies the creator. Minimum length: 0 Maximum length: 64 |
|
create_time |
Long |
Specifies the creation timestamp. Minimum value: 0 Maximum value: 2147483647 |
|
job_id |
String |
Specifies the job ID. Minimum length: 0 Maximum length: 64 |
|
abnormal_items |
Array of strings |
Specifies the ID list of abnormal items. Minimum length: 0 Maximum length: 64 Array length: 0 - 2147483647 |
|
red_count |
Integer |
Specifies the number of abnormal items. Minimum value: 0 Maximum value: 2147483647 |
|
region |
String |
Specifies the region. Minimum length: 0 Maximum length: 64 |
Request Example
GET https://{endpoint}/v2.0/servicerequest/diagnose/records?page_size=10&page_no=1&type=1
null
Response Example
Status code: 200
Code 200 is returned if the operation is successful.
{
"total_count" : 85,
"records" : [ {
"id" : "id",
"status" : "status",
"domain_id" : "domain-id",
"job_id" : "Job ID",
"abnormal_items" : [ "IDs of abnormal items" ],
"red_count" : 8,
"region" : "cn-north-1"
} ]
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Code 200 is returned if the operation is successful. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.