查询离线全量key分析详情
功能介绍
查询离线全量key分析详情。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/instances/{instance_id}/offline/key-analysis/{task_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID。获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
instance_id |
是 |
String |
参数解释: 实例ID。可通过DCS控制台进入实例详情界面查看。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
task_id |
是 |
String |
参数解释: 任务ID。可通过DCS控制台进入离线全量key分析界面查看。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
无
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释: 任务执行记录ID(此ID对应“查询离线全量key分析详情”参数中的任务ID)。 取值范围: 不涉及。 |
instance_id |
String |
参数解释: 实例ID。 取值范围: 不涉及。 |
node_id |
String |
参数解释: 节点ID。 取值范围: 不涉及。 |
backup_id |
String |
参数解释: 备份ID。 取值范围: 不涉及。 |
group_name |
String |
参数解释: 分片名称。 取值范围: 不涉及。 |
node_ip |
String |
参数解释: 节点ipv4地址。 取值范围: 不涉及。 |
node_ipv6 |
String |
参数解释: 节点ipv6地址。 取值范围: 不涉及。 |
node_type |
String |
参数解释: 节点类型。 取值范围: master:主节点 slave:从节点 |
analysis_type |
String |
参数解释: 分析类型。 取值范围: new_backup:新建备份并分析。 old_backup:历史备份文件分析。 |
started_at |
String |
参数解释: 分析任务开始时间。 取值范围: 不涉及。 |
finished_at |
String |
参数解释: 分析任务结束时间。 取值范围: 不涉及。 |
largest_key_prefixes |
Array of LargestKeyPrefix objects |
参数解释: 前缀Key列表。 |
largest_keys |
Array of LargestKey objects |
参数解释: 大key列表。 |
total_bytes |
Integer |
参数解释: Key的总大小,单位:Bytes。 取值范围: 不涉及。 |
total_num |
Integer |
参数解释: Key的总数。 取值范围: 不涉及。 |
type_bytes |
Array of KeyTypeByte objects |
参数解释: 每种类型key的总大小,单位:Bytes。 取值范围: 不涉及。 |
type_num |
Array of KeyTypeNum objects |
参数解释: 每种类型key总数。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
key_prefix |
String |
参数解释: 前缀名称。 取值范围: 不涉及。 |
type |
String |
参数解释: Key的数据类型。 取值范围: string list set zset hash |
bytes |
Integer |
参数解释: Key的大小,单位:Bytes。 取值范围: 不涉及。 |
num |
Integer |
参数解释: 相同前缀key的数量。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
key |
String |
参数解释: Key名称。 取值范围: 不涉及。 |
type |
String |
参数解释: Key的数据类型。 取值范围: string list set zset hash |
bytes |
Integer |
参数解释: Key的大小,单位:Bytes。 取值范围: 不涉及。 |
num_of_elem |
Integer |
参数解释: 元素数量或元素大小(String类型为元素大小,单位:Bytes。非String类型为元素数量)。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
type |
String |
参数解释: Key的数据类型。 取值范围: string list set zset hash |
bytes |
Integer |
参数解释: 每种数据类型Key的总大小,单位:Bytes。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
type |
String |
参数解释: Key的数据类型。 取值范围: string list set zset hash |
num |
Integer |
参数解释: Key类型的总数量。 取值范围: 不涉及。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
参数解释: 错误信息。 取值范围: 不涉及。 |
error_code |
String |
参数解释: 错误码。 取值范围: 请参见错误码。 |
error_ext_msg |
String |
参数解释: 扩展错误信息(暂未使用,赋值为null)。 取值范围: 不涉及。 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
参数解释: 错误信息。 取值范围: 不涉及。 |
error_code |
String |
参数解释: 错误码。 取值范围: 请参见错误码。 |
error_ext_msg |
String |
参数解释: 扩展错误信息(暂未使用,赋值为null)。 取值范围: 不涉及。 |
状态码:403
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
参数解释: 错误信息。 取值范围: 不涉及。 |
error_code |
String |
参数解释: 错误码。 取值范围: 请参见错误码。 |
error_ext_msg |
String |
参数解释: 扩展错误信息(暂未使用,赋值为null)。 取值范围: 不涉及。 |
状态码:404
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
参数解释: 错误信息。 取值范围: 不涉及。 |
error_code |
String |
参数解释: 错误码。 取值范围: 请参见错误码。 |
error_ext_msg |
String |
参数解释: 扩展错误信息(暂未使用,赋值为null)。 取值范围: 不涉及。 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
参数解释: 错误信息。 取值范围: 不涉及。 |
error_code |
String |
参数解释: 错误码。 取值范围: 请参见错误码。 |
error_ext_msg |
String |
参数解释: 扩展错误信息(暂未使用,赋值为null)。 取值范围: 不涉及。 |
请求示例
GET https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/offline/key-analysis/{task_id}
响应示例
状态码:200
查询离线全量key分析详情成功。
{
"id" : "858ee14c-2271-4489-8b82-7bda7459ae3e",
"instance_id" : "5f9057b5-c330-4ee2-8138-7e69896eeec3",
"node_id" : "ff80808191c06d650191c163c53d3b40",
"analysis_type" : "new_backup",
"started_at" : "2024-10-15T02:21:23.534Z",
"finished_at" : "2024-10-15T02:23:23.534Z",
"group_name" : "group-0",
"node_ip" : "10.10.0.0",
"node_ipv6" : "2407:c080:11f0:12c:7cc:d251:a5f2:80b6",
"node_type" : "master",
"largest_key_prefixes" : [ {
"type" : "string",
"key_prefix" : "dcs-bigkey",
"bytes" : 300,
"num" : 1
} ],
"largest_keys" : [ {
"key" : "dcs-bigkey-test",
"type" : "string",
"bytes" : 300,
"num_of_elem" : 1
} ],
"total_bytes" : 300,
"total_num" : 1,
"type_bytes" : [ {
"type" : "string",
"bytes" : 300
} ],
"type_num" : [ {
"type" : "string",
"num" : 1
} ]
}
状态码:400
非法请求。
{
"error_code" : "DCS.4230",
"error_msg" : "Does not support offline key analysis."
}
SDK代码示例
SDK代码示例如下。
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 |
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 ShowOfflineKeyAnalysisTaskSolution {
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();
ShowOfflineKeyAnalysisTaskRequest request = new ShowOfflineKeyAnalysisTaskRequest();
request.withInstanceId("{instance_id}");
request.withTaskId("{task_id}");
try {
ShowOfflineKeyAnalysisTaskResponse response = client.showOfflineKeyAnalysisTask(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 33 |
# 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 = ShowOfflineKeyAnalysisTaskRequest()
request.instance_id = "{instance_id}"
request.task_id = "{task_id}"
response = client.show_offline_key_analysis_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)
|
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 |
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.ShowOfflineKeyAnalysisTaskRequest{}
request.InstanceId = "{instance_id}"
request.TaskId = "{task_id}"
response, err := client.ShowOfflineKeyAnalysisTask(request)
if err == nil {
fmt.Printf("%+v\n", response)
} else {
fmt.Println(err)
}
}
|
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
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 |
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 ShowOfflineKeyAnalysisTaskSolution {
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();
ShowOfflineKeyAnalysisTaskRequest request = new ShowOfflineKeyAnalysisTaskRequest();
request.withInstanceId("{instance_id}");
request.withTaskId("{task_id}");
try {
ShowOfflineKeyAnalysisTaskResponse response = client.showOfflineKeyAnalysisTask(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 33 |
# 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 = ShowOfflineKeyAnalysisTaskRequest()
request.instance_id = "{instance_id}"
request.task_id = "{task_id}"
response = client.show_offline_key_analysis_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)
|
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 |
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.ShowOfflineKeyAnalysisTaskRequest{}
request.InstanceId = "{instance_id}"
request.TaskId = "{task_id}"
response, err := client.ShowOfflineKeyAnalysisTask(request)
if err == nil {
fmt.Printf("%+v\n", response)
} else {
fmt.Println(err)
}
}
|
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
查询离线全量key分析详情成功。 |
400 |
非法请求。 |
401 |
认证信息非法。 |
403 |
请求被拒绝访问。 |
404 |
所请求的资源不存在。 |
500 |
内部服务错误。 |
错误码
请参见错误码。