文档首页/ 分布式缓存服务 DCS/ API参考/ API V2(推荐)/ 实例诊断/ 创建实例诊断任务 - CreateDiagnosisTask
更新时间:2025-10-23 GMT+08:00

创建实例诊断任务 - CreateDiagnosisTask

功能介绍

诊断指定的缓存实例。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    dcs:instance:createDiagnosisTask

    Write

    instance *

    g:EnterpriseProjectId

    • dcs:instance:diagnosis

    -

URI

POST /v2/{project_id}/instances/{instance_id}/diagnosis

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID。获取方法请参见获取项目ID

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

instance_id

String

参数解释

实例ID。可通过DCS控制台进入实例详情界面查看。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

begin_time

String

参数解释

诊断开始时间。UNIX时间戳,单位毫秒。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

end_time

String

参数解释

诊断结束时间。UNIX时间戳,单位毫秒。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

node_ip_list

Array of strings

参数解释

诊断节点IP列表。默认诊断所有节点。

非读写分离实例查询方法如下:

读写分离实例查询方法:调用查询分片信息接口。

约束限制

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

report_id

String

参数解释

报告ID。

取值范围

不涉及。

状态码:400

表4 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释

错误信息。

取值范围

不涉及。

error_code

String

参数解释

错误码。

取值范围

请参见错误码

error_ext_msg

String

参数解释

扩展错误信息(暂未使用,赋值为null)。

取值范围

不涉及。

状态码:500

表5 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释

错误信息。

取值范围

不涉及。

error_code

String

参数解释

错误码。

取值范围

请参见错误码

error_ext_msg

String

参数解释

扩展错误信息(暂未使用,赋值为null)。

取值范围

不涉及。

请求示例

创建实例诊断任务,设置诊断的起止时间和需要诊断的节点IP。

POST https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/diagnosis

{
  "begin_time" : 1618466522486,
  "end_time" : 1618467122486,
  "node_ip_list" : [ "192.168.0.111" ]
}

响应示例

状态码:200

下发诊断任务成功。

{
  "report_id" : "716c9cca-8ce2-4a89-b3db-7cee209d6379"
}

SDK代码示例

SDK代码示例如下。

创建实例诊断任务,设置诊断的起止时间和需要诊断的节点IP。

 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());
        }
    }
}

创建实例诊断任务,设置诊断的起止时间和需要诊断的节点IP。

 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)

创建实例诊断任务,设置诊断的起止时间和需要诊断的节点IP。

 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)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

下发诊断任务成功。

400

非法请求。

500

内部服务错误。

错误码

请参见错误码