DescribeSecret - 查詢憑據的中繼資料資訊 -

查詢憑據的中繼資料資訊。

介面說明

RAM 使用者或 RAM 角色調用該 OpenAPI 需要被授與權限策略詳情，請參見存取控制。
此介面返回指定憑據的中繼資料資訊，不返回憑據值。

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

調試

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

調試

授權資訊

當前API暫無授權資訊透出。

請求參數

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

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

返回參數

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

樣本

正常返回樣本

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": "{\\\"AccountName\\\":\\\"kms\\\",\\\"Database\\\":\\\"kmsdata\\\",\\\"AccountPrivilege\\\":\\\"RoleReadOnly\\\",\\\"CloneAccountName\\\":\\\"kms_clone\\\",\\\"CustomData\\\":{},\\\"InstanceId\\\":\\\"pc-bp134f7hnijoey****\\\",\\\"RegionId\\\":\\\"cn-hangzhou\\\",\\\"SecretSubType\\\":\\\"DoubleUsers\\\"}\"",
  "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": {
    "Tag": [
      {
        "TagValue": "val1",
        "TagKey": "key1"
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
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.	操作無許可權。
404	Forbidden.ResourceNotFound	Resource not found
404	InvalidAccessKeyId.NotFound	The Access Key ID provided does not exist in our records.

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

變更歷史

更多資訊，參考變更詳情。