Updated on 2024-08-06 GMT+08:00

Querying the Secret Version List

Function

This API is used to query the version list of a specified secret.

Constraints

The information returned by this API is the metadata of secret versions, which does not contain secret values.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/secrets/{secret_name}/versions

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

secret_name

Yes

String

Secret name

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

marker

No

String

Pagination parameter. The value is the version number of the last record on the previous page.

limit

No

Integer

Specifies the number of items displayed per page. The default value is 50.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

version_metadatas

Array of VersionMetadata objects

version_metadata object.

page_info

PageInfo object

Pagination information.

Table 5 VersionMetadata

Parameter

Type

Description

id

String

Secret version ID, which is unique under a secret object.

create_time

Long

Time when a secret version was created. The timestamp indicates the total seconds since January 1, 1970.

expire_time

Long

Expiration time of the secret version. The value is a timestamp, that is, the total number of seconds from January 1, 1970 to the time. When the secret subscribes to the version expiration event type, the validity period is determined based on this parameter. This parameter is left blank by default.

kms_key_id

String

ID of the KMS CMK used to encrypt a secret version value.

secret_name

String

Secret name

version_stages

Array of strings

Secret version status list. Every version status is unique under a secret. If you add a status tag in use to a new version, the tag will be automatically removed from the old version. If version_stage is not specified, the temporary tag SYSCURRENT will be added to this version.

Table 6 PageInfo

Parameter

Type

Description

next_marker

String

Query address of the next page (name of the secret at the end of the current page, name of the secret at the start of the next page).

previous_marker

String

Name of the start secret on the current page and name of the end secret on the previous page.

current_count

Integer

Number of records returned on this page.

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error codes

error_msg

String

Error description

Status code: 401

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error codes

error_msg

String

Error description

Status code: 403

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error codes

error_msg

String

Error description

Status code: 404

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error codes

error_msg

String

Error description

Status code: 500

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error codes

error_msg

String

Error description

Status code: 502

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Error codes

error_msg

String

Error description

Status code: 504

Table 13 Response body parameters

Parameter

Type

Description

error_code

String

Error codes

error_msg

String

Error description

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "version_metadatas" : [ {
    "id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e",
    "kms_key_id" : "b168fe00ff56492495a7d22974df2d0b",
    "create_time" : 1581507580000,
    "secret_name" : "secret-name-demo",
    "version_stages" : [ "pending", "used" ]
  } ],
  "page_info" : {
    "next_marker" : "v10",
    "previous_marker" : "v1",
    "current_count" : 10
  }
}

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
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.csms.v1.region.CsmsRegion;
import com.huaweicloud.sdk.csms.v1.*;
import com.huaweicloud.sdk.csms.v1.model.*;


public class ListSecretVersionsSolution {

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

        CsmsClient client = CsmsClient.newBuilder()
                .withCredential(auth)
                .withRegion(CsmsRegion.valueOf("<YOUR REGION>"))
                .build();
        ListSecretVersionsRequest request = new ListSecretVersionsRequest();
        request.withMarker("<marker>");
        request.withLimit(<limit>);
        try {
            ListSecretVersionsResponse response = client.listSecretVersions(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
# coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcsms.v1.region.csms_region import CsmsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcsms.v1 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 = CsmsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CsmsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListSecretVersionsRequest()
        request.marker = "<marker>"
        request.limit = <limit>
        response = client.list_secret_versions(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"
    csms "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/csms/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/csms/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/csms/v1/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 := csms.NewCsmsClient(
        csms.CsmsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListSecretVersionsRequest{}
	markerRequest:= "<marker>"
	request.Marker = &markerRequest
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	response, err := client.ListSecretVersions(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

Request succeeded.

400

Invalid request parameter.

401

A username and password are required.

403

Authentication failed.

404

The requested resource does not exist or is not found.

500

Internal service error.

502

The request failed to be fulfilled because the server received an invalid response from the upstream server.

504

Gateway timed out.

Error Codes

See Error Codes.