Listing Instance Diagnosis Tasks
Function
This API is used to query the list of diagnosis tasks of a specific DCS instance.
Calling Method
For details, see Calling APIs.
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 Policies 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
dcs:instance:listDiagnosisTask
List
instance *
g:EnterpriseProjectId
- dcs:instance:diagnosis
-
URI
GET /v2/{project_id}/instances/{instance_id}/diagnosis
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Definition Project ID. For details, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A |
|
instance_id |
Yes |
String |
Definition Instance ID. It can be viewed on the instance details page on the DCS console. Constraints N/A Range N/A Default Value N/A |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
offset |
No |
Integer |
Definition Offset, which indicates that the generated list is displayed from this offset. For example, if the offset is 3, the generated list is displayed from the fourth record. Constraints N/A Range ≥ 0 Default Value 0 |
|
limit |
No |
Integer |
Definition Number of records displayed on each page. Constraints N/A Range 1–1000 Default Value 10 |
Request Parameters
None
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
diagnosis_report_list |
Array of DiagnosisReportInfo objects |
Definition Diagnosis report list. |
|
total_num |
Integer |
Definition Total number of diagnosis reports. Range N/A |
|
Parameter |
Type |
Description |
|---|---|---|
|
report_id |
String |
Definition Diagnosis report ID. Range N/A |
|
status |
String |
Definition Diagnosis task status. Range
|
|
begin_time |
String |
Definition Start time of a diagnosis period. For example, 2017-03-31T12:24:46.297Z. Range N/A |
|
end_time |
String |
Definition End time of a diagnosis period. For example, 2017-03-31T12:24:46.297Z. Range N/A |
|
created_at |
String |
Definition Time when the diagnosis report is created. Range N/A |
|
node_num |
Integer |
Definition Number of diagnosed nodes. Range N/A |
|
abnormal_item_sum |
Integer |
Definition Total number of abnormal diagnosis items. Range N/A |
|
failed_item_sum |
Integer |
Definition Total number of failed diagnosis items. Range N/A |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_msg |
String |
Definition Error information. Range N/A |
|
error_code |
String |
Definition Error code. Range For details, see Error Codes. |
|
error_ext_msg |
String |
Definition Extended error information. This parameter is not used currently and is set to null. Range N/A |
Status code: 500
|
Parameter |
Type |
Description |
|---|---|---|
|
error_msg |
String |
Definition Error information. Range N/A |
|
error_code |
String |
Definition Error code. Range For details, see Error Codes. |
|
error_ext_msg |
String |
Definition Extended error information. This parameter is not used currently and is set to null. Range N/A |
Example Requests
None
Example Responses
Status code: 200
Instance diagnosis reports listed successfully.
{
"diagnosis_report_list" : [ {
"report_id" : "fb98e37a-3cd9-4c7a-96b1-d878266019e2",
"status" : "finished",
"begin_time" : "2021-04-15T06:02:00.000Z",
"end_time" : "2021-04-15T06:12:00.000Z",
"created_at" : "2021-04-15T06:12:06.641Z",
"abnormal_item_sum" : 2,
"failed_item_sum" : 0,
"node_num" : 2
} ],
"total_num" : 1
}
SDK Sample Code
The SDK sample code is as follows.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.dcs.v2.region.DcsRegion; import com.huaweicloud.sdk.dcs.v2.*; import com.huaweicloud.sdk.dcs.v2.model.*; public class ListDiagnosisTasksSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); DcsClient client = DcsClient.newBuilder() .withCredential(auth) .withRegion(DcsRegion.valueOf("<YOUR REGION>")) .build(); ListDiagnosisTasksRequest request = new ListDiagnosisTasksRequest(); request.withInstanceId("{instance_id}"); try { ListDiagnosisTasksResponse response = client.listDiagnosisTasks(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdcs.v2.region.dcs_region import DcsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdcs.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = DcsClient.new_builder() \ .with_credentials(credentials) \ .with_region(DcsRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListDiagnosisTasksRequest() request.instance_id = "{instance_id}" response = client.list_diagnosis_tasks(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dcs "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := dcs.NewDcsClient( dcs.DcsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListDiagnosisTasksRequest{} request.InstanceId = "{instance_id}" response, err := client.ListDiagnosisTasks(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Instance diagnosis reports listed successfully. |
|
400 |
Invalid request. |
|
500 |
Internal service error. |
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.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot