You can call this operation to query all versions of a secret.

The secret value is not included in the returned information. By default, deprecated secret versions are not returned.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListSecretVersionIds

The operation that you want to perform.

Set the value to ListSecretVersionIds.

SecretName String Yes secret001

The name of the secret.

IncludeDeprecated String No false

Specifies whether to return deprecated secret versions.

Valid values: true and false. Default value: false.

PageNumber Integer No 1

The number of the page to return.

PageSize Integer No 10

The number of entries to return on each page.

Response parameters

Parameter Type Example Description
PageNumber Integer 1

The page number of the returned page.

PageSize Integer 10

The number of entries returned per page.

RequestId String 5b75d8b1-5b6a-4ec0-8e0c-c08befdfad47

The ID of the request.

SecretName String secret001

The name of the secret.

TotalCount Integer 40

The number of entries returned on the current page.

VersionIds Array

The list of secret versions.

CreateTime String 2020-02-21T15:39:26Z

The time when the secret version was created.

VersionId String 00000000000000000000000000000000203

The version of the secret.

VersionStages List { "VersionStage": [ "ACSCurrent", "UStage1", "Ustage2" ] }

The stage labels that mark the secret version.

Examples

Sample requests

http(s)://[Endpoint]/? Action=ListSecretVersionIds
&<Common request parameters>

Sample success responses

XML format

<SecretName>seret001</SecretName>
<VersionIds>
    <VersionId>
        <VersionId>00000000000000000000000000000000203</VersionId>
        <VersionStages>
            <VersionStage>ACSCurrent</VersionStage>
            <VersionStage>UStage1</VersionStage>
            <VersionStage>Ustage2</VersionStage>
        </VersionStages>
    </VersionId>
    <VersionId>
        <VersionId>00000000000000000000000000000001</VersionId>
        <VersionStages>
            <VersionStage>ACSPrevious</VersionStage>
        </VersionStages>
    </VersionId>
</VersionIds>
<RequestId>5b75d8b1-5b6a-4ec0-8e0c-c08befdfad47</RequestId>
<PageNumber>1</PageNumber>
<PageSize>10</PageSize>
<TotalCount>4</TotalCount>

JSON format

{
    "SecretName": "seret001",
    "VersionIds": {
        "VersionId": [
            {
                "VersionId": "00000000000000000000000000000000203",
                "VersionStages": {
                    "VersionStage": [
                        "ACSCurrent",
                        "UStage1",
                        "Ustage2"
                    ]
                }
            },
            {
                "VersionId": "00000000000000000000000000000001",
                "VersionStages": {
                    "VersionStage": [
                        "ACSPrevious"
                    ]
                }
            }
        ]
    },
    "RequestId": "5b75d8b1-5b6a-4ec0-8e0c-c08befdfad47",
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 4
}

Error codes

For a list of error codes, visit the API Error Center.