更新时间:2024-03-04 GMT+08:00

查询过期Key扫描记录

功能介绍

查询过期Key扫描记录。

调用方法

请参见如何调用API

URI

GET /v2/{project_id}/instances/{instance_id}/auto-expire/histories

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

instance_id

String

实例ID

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

偏移量,表示从此偏移量开始查询,偏移量大于等于0。

limit

Integer

每页显示的条目数量。

status

String

过期key扫描任务状态

枚举值:

  • waiting

  • running

  • success

  • failed

请求参数

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

records

Array of SimpleKeyScanRecord objects

过期key记录。

instance_id

String

实例ID。

total

Integer

扫描过期key的总数。

count

Integer

扫描过期key的次数。

表4 SimpleKeyScanRecord

参数

参数类型

描述

id

String

扫描ID。

instance_id

String

实例ID。

status

String

扫描状态。

枚举值:

  • waiting

  • running

  • success

  • failed

scan_type

String

扫描类型。

  • auto:自动扫描。

  • manual:手动扫描。

枚举值:

  • auto

  • manual

num

Integer

一次扫描过期key的数量。

created_at

String

创建时间,格式为:2023-06-13T13:46:14.771Z。

started_at

String

开始时间,格式为:2023-06-13T13:46:14.771Z。

finished_at

String

完成时间,格式为:2020-06-15T02:21:18.669Z。

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

最大长度:1024

error_code

String

错误码。

最大长度:9

error_ext_msg

String

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

最大长度:1024

状态码: 500

表6 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

最大长度:1024

error_code

String

错误码。

最大长度:9

error_ext_msg

String

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

最大长度:1024

请求示例

GET https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/auto-expire/histories

响应示例

状态码: 200

查询过期Key扫描记录成功。

{
  "records" : [ {
    "id" : "8476c93a-c3bc-494a-924c-29a2e71ea0d9",
    "instance_id" : "69f99808-34cd-4ce6-ae73-fd03b261b5f3",
    "status" : "running",
    "scan_type" : "auto",
    "num" : 100,
    "created_at" : "2023-06-13T13:46:14.771Z",
    "started_at" : "2023-06-13T13:46:15.113Z",
    "finished_at" : ""
  } ],
  "instance_id" : "69f99808-34cd-4ce6-ae73-fd03b261b5f3",
  "total" : 1,
  "count" : 1
}

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
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 ShowExpireKeyScanInfoSolution {

    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");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        DcsClient client = DcsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DcsRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowExpireKeyScanInfoRequest request = new ShowExpireKeyScanInfoRequest();
        request.withOffset(<offset>);
        request.withLimit(<limit>);
        request.withStatus(ShowExpireKeyScanInfoRequest.StatusEnum.fromValue("<status>"));
        try {
            ShowExpireKeyScanInfoResponse response = client.showExpireKeyScanInfo(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
# coding: utf-8

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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = DcsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DcsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowExpireKeyScanInfoRequest()
        request.offset = <offset>
        request.limit = <limit>
        request.status = "<status>"
        response = client.show_expire_key_scan_info(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
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")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := dcs.NewDcsClient(
        dcs.DcsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ShowExpireKeyScanInfoRequest{}
	offsetRequest:= int32(<offset>)
	request.Offset = &offsetRequest
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	statusRequest:= model.GetShowExpireKeyScanInfoRequestStatusEnum().<STATUS>
	request.Status = &statusRequest
	response, err := client.ShowExpireKeyScanInfo(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

查询过期Key扫描记录成功。

400

非法请求。

500

内部服务器错误。

错误码

请参见错误码