文档

ListSecretVersionIds

更新时间:

调用ListSecretVersionIds接口查询凭据的所有版本信息。

版本信息中不包含凭据值。默认只返回有版本状态的凭据版本。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称

类型

是否必选

示例值

描述

Action String ListSecretVersionIds

要执行的操作。取值:ListSecretVersionIds

SecretName String secret001

凭据名称或凭据资源名称(ARN)。

说明 访问其他阿里云账号下的凭据时,必须输入凭据ARN。凭据ARN的格式为acs:kms:${region}:${account}:secret/${secret-name}
IncludeDeprecated String false

返回值中是否包含没有版本状态的凭据版本。

取值范围:

  • false(默认值):不包含
  • true:包含
PageNumber Integer 1

分页查询时,设置当前页面的页码。默认值:1。

PageSize Integer 10

分页查询时,设置每页大小。默认值:20。

返回数据

名称

类型

示例值

描述

SecretName String secret001

凭据名称。

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

本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

PageSize Integer 10

当前页大小。

PageNumber Integer 1

当前页码。

TotalCount Integer 1

列表项总个数。

VersionIds Array of VersionId

凭据的版本信息列表。

VersionId
VersionId String v1

版本号。

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

版本的创建时间。

VersionStages Array of String {"VersionStage": ["ACSCurrent","uStage1"]}

版本的状态标记。

示例

请求示例

http(s)://[Endpoint]/?Action=ListSecretVersionIds
&SecretName=secret001
&IncludeDeprecated=false
&PageNumber=1
&PageSize=10
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListSecretVersionIdsResponse>
    <SecretName>secret001</SecretName>
    <RequestId>5b75d8b1-5b6a-4ec0-8e0c-c08befdfad47</RequestId>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
    <TotalCount>1</TotalCount>
    <VersionIds>
        <VersionId>v1</VersionId>
        <CreateTime>2024-02-21T15:39:26Z</CreateTime>
        <VersionStages>{"VersionStage": ["ACSCurrent","uStage1"]}</VersionStages>
    </VersionIds>
</ListSecretVersionIdsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "SecretName" : "secret001",
  "RequestId" : "5b75d8b1-5b6a-4ec0-8e0c-c08befdfad47",
  "PageSize" : 10,
  "PageNumber" : 1,
  "TotalCount" : 1,
  "VersionIds" : [ {
    "VersionId" : "v1",
    "CreateTime" : "2024-02-21T15:39:26Z",
    "VersionStages" : [ "{\"VersionStage\": [\"ACSCurrent\",\"uStage1\"]}" ]
  } ]
}

错误码

访问错误中心查看更多错误码。