DescribeSecret - - 阿里雲

此介面返回指定憑據的中繼資料資訊，不返回憑據值。

本文將提供一個樣本，查詢一個名稱為secret001憑據的中繼資料資訊。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	DescribeSecret	要執行的操作。取值：DescribeSecret。
SecretName	String	是	secret001	憑據名稱或憑據資源名稱（ARN）。說明訪問其他阿里雲帳號下的憑據時，必須輸入憑據ARN。憑據ARN的格式為`acs:kms:${region}:${account}:secret/${secret-name}`。
FetchTags	String	否	true	是否在返回參數中包含憑據的資源標籤。取值： true：包含資源標籤。 false（預設值）：不包含資源標籤。

關於公用請求參數的詳情，請參見公用參數。

返回資料

名稱	類型	樣本值	描述
UpdateTime	String	2024-02-21T15:39:26Z	憑據的更新時間。
CreateTime	String	2024-02-21T15:39:26Z	建立憑據的時間。
NextRotationDate	String	2024-07-06T18:22:03Z	下一次輪轉的時間。說明當開啟自動輪轉時，返回該參數。
EncryptionKeyId	String	key-hzz63ca8cbe3hefht****	加密憑據值的KMS密鑰的標識符。
RotationInterval	String	3153600s	憑據自動輪轉的周期。格式為`integer[unit]`，其中`integer`表示時間長度，`unit`表示時間單位。 `unit`取值：s（秒）。例如：7天的輪轉周期為604800s。說明當開啟自動輪轉時，返回該參數。
Arn	String	acs:kms:cn-hangzhou:154035569884****:secret/secret001	憑據的資源名稱（ARN）。
ExtendedConfig	String	{\"AccountName\":\"kms\",\"Database\":\"kmsdata\",\"AccountPrivilege\":\"RoleReadOnly\",\"CloneAccountName\":\"kms_clone\",\"CustomData\":{},\"InstanceId\":\"pc-bp134f7hnijoey****\",\"RegionId\":\"cn-hangzhou\",\"SecretSubType\":\"DoubleUsers\"}"	憑據的拓展配置。說明僅RDS憑據、RAM憑據、PolarDB憑據或ECS憑據返回該參數。
LastRotationDate	String	2022-07-05T08:22:03Z	最近一次輪轉的時間。說明當憑據發生過輪轉時返回該參數。
RequestId	String	93348dfb-3627-4417-8d90-487a76a909c9	本次調用請求的ID，是由阿里雲為該請求產生的唯一識別碼，可用於排查和定位問題。
Description	String	userinfo	憑據的描述資訊。
SecretName	String	secret001	憑據名稱。
AutomaticRotation	String	Enabled	是否開啟自動輪轉。取值： Enabled：開啟自動輪轉。 Disabled：不開啟自動輪轉。 Invalid：輪轉狀態異常，KMS無法為您自動輪轉。說明僅RDS憑據、PolarDB憑據、RAM憑據或ECS憑據返回該參數。
SecretType	String	Rds	憑據類型。取值： Generic：通用憑據。 Rds：RDS憑據。 RAMCredentials：RAM憑據。 ECS：ECS憑據。 PolarDB：PolarDB憑據
PlannedDeleteTime	String	2025-03-21T15:45:12Z	計劃刪除時間。
DKMSInstanceId	String	kst-bjj62d8f5e0sgtx8h****	KMS執行個體的執行個體ID。
Tags	Array of Tag		憑據的資源標籤。如果入參FetchTags取值為false或者未指定，則不返回該參數。
Tag
TagValue	String	val1	標籤值。
TagKey	String	key1	標籤鍵。

樣本

請求樣本

http(s)://[Endpoint]/?Action=DescribeSecret
&SecretName=secret001
&FetchTags=true
&公用請求參數

正常返回樣本

XML格式

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

<DescribeSecretResponse>
    <UpdateTime>2024-02-21T15:39:26Z</UpdateTime>
    <CreateTime>2024-02-21T15:39:26Z</CreateTime>
    <NextRotationDate>2024-07-06T18:22:03Z</NextRotationDate>
    <EncryptionKeyId>key-hzz63ca8cbe3hefht****</EncryptionKeyId>
    <RotationInterval>3153600s</RotationInterval>
    <Arn>acs:kms:cn-hangzhou:154035569884****:secret/secret001</Arn>
    <ExtendedConfig>{\"SecretSubType\":\"SingleUser\", \"DBInstanceId\":\"rm-uf667446pc955****\",  \"CustomData\":{} }</ExtendedConfig>
    <LastRotationDate>2022-07-05T08:22:03Z</LastRotationDate>
    <RequestId>93348dfb-3627-4417-8d90-487a76a909c9</RequestId>
    <Description>userinfo</Description>
    <SecretName>secret001</SecretName>
    <AutomaticRotation>Enabled</AutomaticRotation>
    <SecretType>Rds</SecretType>
    <PlannedDeleteTime>2025-03-21T15:45:12Z</PlannedDeleteTime>
    <DKMSInstanceId>kst-bjj62d8f5e0sgtx8h****</DKMSInstanceId>
    <Tags>
        <TagValue>val1</TagValue>
        <TagKey>key1</TagKey>
    </Tags>
</DescribeSecretResponse>

JSON格式

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

{
  "UpdateTime" : "2024-02-21T15:39:26Z",
  "CreateTime" : "2024-02-21T15:39:26Z",
  "NextRotationDate" : "2024-07-06T18:22:03Z",
  "EncryptionKeyId" : "key-hzz63ca8cbe3hefht****",
  "RotationInterval" : "3153600s",
  "Arn" : "acs:kms:cn-hangzhou:154035569884****:secret/secret001",
  "ExtendedConfig" : "{\\\"SecretSubType\\\":\\\"SingleUser\\\", \\\"DBInstanceId\\\":\\\"rm-uf667446pc955****\\\",  \\\"CustomData\\\":{} }",
  "LastRotationDate" : "2022-07-05T08:22:03Z",
  "RequestId" : "93348dfb-3627-4417-8d90-487a76a909c9",
  "Description" : "userinfo",
  "SecretName" : "secret001",
  "AutomaticRotation" : "Enabled",
  "SecretType" : "Rds",
  "PlannedDeleteTime" : "2025-03-21T15:45:12Z",
  "DKMSInstanceId" : "kst-bjj62d8f5e0sgtx8h****",
  "Tags" : [ {
    "TagValue" : "val1",
    "TagKey" : "key1"
  } ]
}

錯誤碼

HttpCode	錯誤碼	錯誤資訊	描述
400	IllegalTimestamp	The input parameter Timestamp that is mandatory for processing this request is not supplied.	輸入參數“時間戳記”標明該請求已經不在可處理時間範圍內。
400	InvalidParameter	The specified parameter is not valid.	參數非法。
403	Forbidden.NoPermission	You are not authorized to perform the operation.	操作無許可權。

訪問錯誤中心查看更多錯誤碼。