Starting Quick Diagnosis
Function
Start quick diagnosis.
URI
POST /v2.0/servicerequest/diagnose/job/start
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 |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
type |
Yes |
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: 4 |
|
params |
No |
Map<String,String> |
Specifies the unique parameters required for each type of tasks. For example, the EIP needs to be transferred for ECS, and the instance ID needs to be transferred for RDS. |
|
region_id |
No |
String |
Specifies the region ID. Minimum length: 0 Maximum length: 65535 |
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 |
|
job_id |
String |
Specifies the job ID. Minimum length: 1 Maximum length: 64 |
Request Example
POST https://{endpoint}/v2.0/servicerequest/diagnose/job/start
{
"type" : 1,
"region_id" : "cn-north-7"
}
Response Example
Status code: 200
Code 200 is returned if the operation is successful.
{
"job_id" : "Job ID",
}
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.
