Creating an Instance Diagnosis Task
Function
This API is used to diagnose 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:createDiagnosisTask
Write
instance *
g:EnterpriseProjectId
- dcs:instance:diagnosis
-
URI
POST /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 |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
begin_time |
Yes |
String |
Definition Diagnosis start time. The value is a UNIX timestamp, in milliseconds. Constraints N/A Range N/A Default Value N/A |
|
end_time |
Yes |
String |
Definition Diagnosis end time. The value is a UNIX timestamp, in milliseconds. Constraints N/A Range N/A Default Value N/A |
|
node_ip_list |
No |
Array of strings |
Definition IP addresses of diagnosed nodes. By default, all nodes are diagnosed. Query methods for an instance that is not the read/write splitting type.:
For read/write splitting instances, call the API used to query shard information. Constraints N/A |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
report_id |
String |
Definition Report ID. 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
Creating an instance diagnosis task and setting the diagnosis start time and end time and the IP address of the node to be diagnosed
POST https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/diagnosis
{
"begin_time" : 1618466522486,
"end_time" : 1618467122486,
"node_ip_list" : [ "192.168.0.111" ]
}
Example Responses
Status code: 200
The diagnosis task is successfully delivered.
{
"report_id" : "716c9cca-8ce2-4a89-b3db-7cee209d6379"
}
SDK Sample Code
The SDK sample code is as follows.
Creating an instance diagnosis task and setting the diagnosis start time and end time and the IP address of the node to be diagnosed
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 49 50 51 52 53 54 55 56 57 |
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.*; import java.util.List; import java.util.ArrayList; public class CreateDiagnosisTaskSolution { 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(); CreateDiagnosisTaskRequest request = new CreateDiagnosisTaskRequest(); request.withInstanceId("{instance_id}"); CreateDiagnosisTaskBody body = new CreateDiagnosisTaskBody(); List<String> listbodyNodeIpList = new ArrayList<>(); listbodyNodeIpList.add("192.168.0.111"); body.withNodeIpList(listbodyNodeIpList); body.withEndTime("1618467122486"); body.withBeginTime("1618466522486"); request.withBody(body); try { CreateDiagnosisTaskResponse response = client.createDiagnosisTask(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()); } } } |
Creating an instance diagnosis task and setting the diagnosis start time and end time and the IP address of the node to be diagnosed
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 |
# 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 = CreateDiagnosisTaskRequest() request.instance_id = "{instance_id}" listNodeIpListbody = [ "192.168.0.111" ] request.body = CreateDiagnosisTaskBody( node_ip_list=listNodeIpListbody, end_time="1618467122486", begin_time="1618466522486" ) response = client.create_diagnosis_task(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Creating an instance diagnosis task and setting the diagnosis start time and end time and the IP address of the node to be diagnosed
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 |
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.CreateDiagnosisTaskRequest{} request.InstanceId = "{instance_id}" var listNodeIpListbody = []string{ "192.168.0.111", } request.Body = &model.CreateDiagnosisTaskBody{ NodeIpList: &listNodeIpListbody, EndTime: "1618467122486", BeginTime: "1618466522486", } response, err := client.CreateDiagnosisTask(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 |
The diagnosis task is successfully delivered. |
|
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