更新时间:2025-05-13 GMT+08:00

修改自动扫描配置

功能介绍

修改过期key自动扫描配置。

调用方法

请参见如何调用API

URI

PUT /v2/{project_id}/instances/{instance_id}/scan-expire-keys/autoscan-config

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

instance_id

String

参数解释

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

enable_auto_scan

Boolean

参数解释

是否开启缓存分析定时任务。

约束限制

不涉及。

取值范围

  • true

  • false

默认取值

不涉及。

first_scan_at

String

参数解释

首次扫描时间,例如:2023-07-07T15:00:05.000。当enable_auto_scan设置为true时,该参数为必选。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

interval

Integer

参数解释

扫描间隔时间(单位:秒)。当enable_auto_scan设置为true时,该参数为必选。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

timeout

Integer

参数解释

扫描超时时间(单位:秒)。扫描超过设置的超时时间后,返回失败,以便能继续进行下一轮扫描。当enable_auto_scan设置为true时,该参数为必选。

约束限制

扫描超时时间必须大于等于扫描间隔时间的2倍。

取值范围

不涉及。

默认取值

不涉及。

scan_keys_count

Integer

参数解释

迭代扫描key的数量。例如:redis中有1000万个key,迭代扫描key数量设为1000,则迭代1万次可完成全库扫描。当enable_auto_scan设置为true时,该参数为必选。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

instance_id

String

参数解释

实例ID。

取值范围

不涉及。

enable_auto_scan

Boolean

参数解释

是否开启自动扫描。

取值范围

  • true

  • false

first_scan_at

String

参数解释

首次扫描时间,例如:2023-07-07T15:00:05.000。

取值范围

不涉及。

interval

Integer

参数解释

扫描间隔时间(单位:秒)。

取值范围

不涉及。

timeout

Integer

参数解释

扫描超时时间(单位:秒)。

取值范围

不涉及。

scan_keys_count

Integer

参数解释

迭代扫描key数量。

取值范围

不涉及。

updated_at

AnyType

参数解释

配置更新时间,时间格式为2020-06-15T02:21:18.669Z。

取值范围

不涉及。

状态码:400

表4 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释

错误信息。

取值范围

不涉及。

error_code

String

参数解释

错误码。

取值范围

请参见错误码

error_ext_msg

String

参数解释

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

取值范围

不涉及。

状态码:401

表5 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释

错误信息。

取值范围

不涉及。

error_code

String

参数解释

错误码。

取值范围

请参见错误码

error_ext_msg

String

参数解释

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

取值范围

不涉及。

状态码:403

表6 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释

错误信息。

取值范围

不涉及。

error_code

String

参数解释

错误码。

取值范围

请参见错误码

error_ext_msg

String

参数解释

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

取值范围

不涉及。

状态码:404

表7 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释

错误信息。

取值范围

不涉及。

error_code

String

参数解释

错误码。

取值范围

请参见错误码

error_ext_msg

String

参数解释

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

取值范围

不涉及。

状态码:500

表8 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释

错误信息。

取值范围

不涉及。

error_code

String

参数解释

错误码。

取值范围

请参见错误码

error_ext_msg

String

参数解释

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

取值范围

不涉及。

请求示例

PUT https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/scan-expire-keys/autoscan-config

{
  "enable_auto_scan" : "true",
  "first_scan_at" : "2023-02-07T15:00:05.000Z",
  "interval" : 86400,
  "timeout" : 172800,
  "scan_keys_count" : 10
}

响应示例

状态码:200

修改自动扫描配置成功。

{
  "instance_id" : "162d315d-a67d-4ba1-8ca5-8d0e95c5bf7c",
  "enable_auto_scan" : true,
  "first_scan_at" : "2023-06-13T21:00:00.000Z",
  "interval" : 86400,
  "timeout" : 172800,
  "scan_keys_count" : 10,
  "updated_at" : "2023-06-13T13:13:12.685Z"
}

状态码:400

非法请求。

{
  "error_code" : "DCS.4822",
  "error_msg" : "The scan_keys_count parameter is invalid. Its must Greater than or equal to 10, and Less than or equal to 1000."
}

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
50
51
52
53
54
55
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 UpdateExpireAutoScanConfigSolution {

    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();
        UpdateExpireAutoScanConfigRequest request = new UpdateExpireAutoScanConfigRequest();
        request.withInstanceId("{instance_id}");
        UpdateAutoScanConfigRequestBody body = new UpdateAutoScanConfigRequestBody();
        body.withScanKeysCount(10);
        body.withTimeout(172800);
        body.withInterval(86400);
        body.withFirstScanAt("2023-02-07T15:00:05.000Z");
        body.withEnableAutoScan(true);
        request.withBody(body);
        try {
            UpdateExpireAutoScanConfigResponse response = client.updateExpireAutoScanConfig(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
34
35
36
37
38
39
# 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 = UpdateExpireAutoScanConfigRequest()
        request.instance_id = "{instance_id}"
        request.body = UpdateAutoScanConfigRequestBody(
            scan_keys_count=10,
            timeout=172800,
            interval=86400,
            first_scan_at="2023-02-07T15:00:05.000Z",
            enable_auto_scan=True
        )
        response = client.update_expire_auto_scan_config(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
40
41
42
43
44
45
46
47
48
49
50
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.UpdateExpireAutoScanConfigRequest{}
	request.InstanceId = "{instance_id}"
	scanKeysCountUpdateAutoScanConfigRequestBody:= int32(10)
	timeoutUpdateAutoScanConfigRequestBody:= int32(172800)
	intervalUpdateAutoScanConfigRequestBody:= int32(86400)
	firstScanAtUpdateAutoScanConfigRequestBody:= "2023-02-07T15:00:05.000Z"
	enableAutoScanUpdateAutoScanConfigRequestBody:= true
	request.Body = &model.UpdateAutoScanConfigRequestBody{
		ScanKeysCount: &scanKeysCountUpdateAutoScanConfigRequestBody,
		Timeout: &timeoutUpdateAutoScanConfigRequestBody,
		Interval: &intervalUpdateAutoScanConfigRequestBody,
		FirstScanAt: &firstScanAtUpdateAutoScanConfigRequestBody,
		EnableAutoScan: &enableAutoScanUpdateAutoScanConfigRequestBody,
	}
	response, err := client.UpdateExpireAutoScanConfig(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

修改自动扫描配置成功。

400

非法请求。

401

认证信息非法。

403

请求被拒绝访问。

404

所请求的资源不存在。

500

内部服务错误。

错误码

请参见错误码