Modifying Automatic Scanning Configuration
Function
This API is used to modify the automatic scanning configuration of expired keys.
Calling Method
For details, see Calling APIs.
URI
PUT /v2/{project_id}/instances/{instance_id}/scan-expire-keys/autoscan-config
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Parameter description: Project ID. For details, see Obtaining a Project ID. Constraints: N/A Value range: N/A Default value: N/A |
instance_id |
Yes |
String |
Parameter description: Instance ID. It can be viewed on the instance details page on the DCS console. Constraints: N/A Value range: N/A Default value: N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enable_auto_scan |
No |
Boolean |
Parameter description: Whether to enable scheduled cache analysis. Constraints: N/A Value range:
Default value: N/A |
first_scan_at |
No |
String |
Definition: First scan time, for example, 2023-07-07T15:00:05.000. This parameter is mandatory when enable_auto_scan is set to true. Constraints: N/A Range: N/A Default Value: N/A |
interval |
No |
Integer |
Definition: Scan interval, in seconds. This parameter is mandatory when enable_auto_scan is set to true. Constraints: N/A Range: N/A Default Value: N/A |
timeout |
No |
Integer |
Definition: Scan timeout, in seconds. If one scan times out, a failure message is returned, and the next scan can continue. This parameter is mandatory when enable_auto_scan is set to true. Constraints: Set the timeout to at least twice the interval. Range: N/A Default Value: N/A |
scan_keys_count |
No |
Integer |
Definition: Number of keys scanned in iteration. For example, if there are 10 million keys in Redis and the number of keys to iterate is set to 1000, a full scan will be complete after 10,000 iterations. This parameter is mandatory when enable_auto_scan is set to true. Constraints: N/A Range: N/A Default Value: N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
instance_id |
String |
Parameter description: Instance ID. Value range: N/A |
enable_auto_scan |
Boolean |
Parameter description: Whether to enable automatic scan. Value range:
|
first_scan_at |
String |
Parameter description: First scan time, for example, 2023-07-07T15:00:05.000. Value range: N/A |
interval |
Integer |
Parameter description: Scan interval, in seconds. Value range: N/A |
timeout |
Integer |
Parameter description: Scan timeout, in seconds. Value range: N/A |
scan_keys_count |
Integer |
Parameter description: Number of keys scanned in iteration. Value range: N/A |
updated_at |
AnyType |
Parameter description: Time when the configuration is updated. The time format is 2020-06-15T02:21:18.669Z. Value range: N/A |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Parameter description: Error information. Value range: N/A |
error_code |
String |
Parameter description: Error code. Value range: For details, see Error Codes. |
error_ext_msg |
String |
Parameter description: Extended error information. This parameter is not used currently and is set to null. Value range: N/A |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Parameter description: Error information. Value range: N/A |
error_code |
String |
Parameter description: Error code. Value range: For details, see Error Codes. |
error_ext_msg |
String |
Parameter description: Extended error information. This parameter is not used currently and is set to null. Value range: N/A |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Parameter description: Error information. Value range: N/A |
error_code |
String |
Parameter description: Error code. Value range: For details, see Error Codes. |
error_ext_msg |
String |
Parameter description: Extended error information. This parameter is not used currently and is set to null. Value range: N/A |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Parameter description: Error information. Value range: N/A |
error_code |
String |
Parameter description: Error code. Value range: For details, see Error Codes. |
error_ext_msg |
String |
Parameter description: Extended error information. This parameter is not used currently and is set to null. Value range: N/A |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Parameter description: Error information. Value range: N/A |
error_code |
String |
Parameter description: Error code. Value range: For details, see Error Codes. |
error_ext_msg |
String |
Parameter description: Extended error information. This parameter is not used currently and is set to null. Value range: N/A |
Example Requests
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 }
Example Responses
Status code: 200
Automatic scanning configuration modified successfully.
{ "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" }
Status code: 400
Invalid request.
{ "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 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 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) } } |
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 |
Automatic scanning configuration modified successfully. |
400 |
Invalid request. |
401 |
Invalid authentication information. |
403 |
Request rejected. |
404 |
The requested resource could not be found. |
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