Listing Offline Keys Analysis Tasks
Function
This API is used to query the offline key analysis task list. Redis 4.0, 5.0, 6.0, and the enterprise edition are supported.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/instances/{instance_id}/offline/key-analysis
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition: Project ID. For details, see Obtaining a Project ID. Constraints: N/A Range: N/A Default Value: N/A |
instance_id |
Yes |
String |
Definition: Instance ID. It can be viewed on the instance details page on the DCS console. Constraints: N/A Range: N/A Default Value: N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
offset |
No |
Integer |
Definition: Offset where the query starts. Constraints: N/A Range: ≥ 0 Default Value: 0 |
limit |
No |
Integer |
Definition: Number of records displayed on each page. Constraints: N/A Range: ≥ 0 Default Value: 10 |
status |
No |
String |
Definition: Status of an offline analysis task. Constraints: N/A Range: waiting: The task is waiting. running: The task is in progress. success: The task is executed successfully. failed: The task fails to be executed. Default Value: N/A |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
instance_id |
String |
Definition: Instance ID. Range: N/A |
total |
Integer |
Definition: Total number of offline key analysis records. Range: N/A |
records |
Array of OfflineKeyAnalysisRecord objects |
Definition: Offline key analysis record list. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition: Task execution record ID. (This ID corresponds to the task ID in the parameter for querying offline key analysis details.) Range: N/A |
status |
String |
Definition: Status of an offline analysis task. Range: waiting: The task is waiting. running: The task is in progress. success: The task is executed successfully. failed: The task fails to be executed. |
created_at |
String |
Definition: Time when an analysis task is created. Range: N/A |
started_at |
String |
Definition: Start time of an analysis task. Range: N/A |
finished_at |
String |
Definition: End time of an analysis task. Range: N/A |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Definition: Error message. Range: N/A |
error_code |
String |
Definition: Error code. Range: For details, see Error Codes. |
error_ext_msg |
String |
Definition: Extended error information. This parameter is not used currently and is set to null. Range: N/A |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Definition: Error message. Range: N/A |
error_code |
String |
Definition: Error code. Range: For details, see Error Codes. |
error_ext_msg |
String |
Definition: Extended error information. This parameter is not used currently and is set to null. Range: N/A |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Definition: Error message. Range: N/A |
error_code |
String |
Definition: Error code. Range: For details, see Error Codes. |
error_ext_msg |
String |
Definition: Extended error information. This parameter is not used currently and is set to null. Range: N/A |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Definition: Error message. Range: N/A |
error_code |
String |
Definition: Error code. Range: For details, see Error Codes. |
error_ext_msg |
String |
Definition: Extended error information. This parameter is not used currently and is set to null. Range: N/A |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Definition: Error message. Range: N/A |
error_code |
String |
Definition: Error code. Range: For details, see Error Codes. |
error_ext_msg |
String |
Definition: Extended error information. This parameter is not used currently and is set to null. Range: N/A |
Example Requests
GET https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/offline/key-analysis
Example Responses
Status code: 200
Listing offline keys analysis tasks.
{ "instance_id" : "5f9057b5-c330-4ee2-8138-7e69896eeec3", "total" : 1, "records" : [ { "id" : "858ee14c-2271-4489-8b82-7bda7459ae3e", "status" : "success", "created_at" : "2024-10-15T02:21:18.669Z", "started_at" : "2024-10-15T02:21:23.534Z", "finished_at" : "2024-10-15T02:21:25.588Z" } ] }
Status code: 400
Invalid request.
{ "error_code" : "DCS.4230", "error_msg" : "Does not support offline key analysis." }
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 |
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 ListOfflineKeyAnalysisTaskSolution { 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(); ListOfflineKeyAnalysisTaskRequest request = new ListOfflineKeyAnalysisTaskRequest(); request.withInstanceId("{instance_id}"); try { ListOfflineKeyAnalysisTaskResponse response = client.listOfflineKeyAnalysisTask(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 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 = ListOfflineKeyAnalysisTaskRequest() request.instance_id = "{instance_id}" response = client.list_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 |
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.ListOfflineKeyAnalysisTaskRequest{} request.InstanceId = "{instance_id}" response, err := client.ListOfflineKeyAnalysisTask(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 |
Listing offline keys analysis tasks. |
400 |
Invalid request. |
401 |
Invalid authentication information. |
403 |
Rejected request. |
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