シークレットのメタデータを照会します。

この操作は、シークレットのメタデータを返します。 この操作はシークレット値を返しません。

この例では、secret001という名前のシークレットのメタデータが照会されます。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須／任意 例 説明
操作 String 必須 DescribeSecret

実行する操作です。 値をDescribeSecretに設定します。

SecretName String 必須 secret001

秘密の名前。The name of the secret.

FetchTags String 任意 真実

シークレットのリソースタグを返すかどうかを指定します。 設定可能な値は以下のとおりです。

  • true: リソースタグが返されます。
  • false: リソースタグは返されません。 デフォルト値です。

共通リクエストパラメーターの詳細については、「共通パラメーター」をご参照ください。

レスポンスパラメーター

パラメーター データ型 例 説明
UpdateTime String 2022-02-21T15:39:26Z

シークレットが更新された時刻。

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

シークレットが作成された時刻。

NextRotationDate String 2022-07-06T18:22:03Z

次のローテーションが実行される時刻。

注 このパラメーターは、自動回転が有効になっている場合に返されます。
暗号化KeyId String 00aa68af-2c02-4f68-95fe-3435d330 ****

シークレット値の暗号化に使用される顧客マスターキー (CMK) のID。

RotationInterval String 3153600s

自動回転の間隔。

値はinteger[unit] 形式です。 integerは時間の長さを示します。 unit: 時間の単位を示します。 unitの値はsとして固定されます。 たとえば、値が604800秒の場合、7日間隔で自動ローテーションが実行されます。

注 このパラメーターは、自動回転が有効になっている場合に返されます。
Arn String acs:kms:cn-hangzhou:154035569884 ****:secret/secret001

シークレットのAlibaba Cloudリソース名 (ARN) 。

ExtendedConfig String {\"SecretSubType\":\"SingleUser\", \"DBInstanceId\":\"rm-uf667446pc955 ****\", \"CustomData\" :{}}

シークレットの拡張設定。

注 このパラメーターは、マネージドApsaraDB RDSシークレット、マネージドRAM (Resource Access Management) シークレット、またはマネージドECS (Elastic Compute Service) シークレットに対してのみ返されます。
LastRotationDate String 2022-07-05T08:22:03Z

最後のローテーションが実行された時刻。

注 このパラメーターは、シークレットがローテーションされた場合に返されます。
RequestId String 93348dfb-3627-4417-8d90-487a76a909c9

リクエストのID。問題の特定とトラブルシューティングに使用されます。

説明 String userinfo

The description of the secret.

SecretName String secret001

秘密の名前。The name of the secret.

AutomaticRotation String 有効

自動回転が有効かどうかを示します。 設定可能な値は以下のとおりです。

  • Enabled: 自動ローテーションが有効になっていることを示します。
  • Disabled: 自動ローテーションが無効であることを示します。
  • 無効: 自動ローテーションのステータスが異常であることを示します。 この場合、Secrets Managerはシークレットを自動的に回転できません。
注 このパラメーターは、マネージドApsaraDB RDSシークレット、マネージドRAMシークレット、またはマネージドECSシークレットに対してのみ返されます。
SecretType String Rds

シークレットのタイプ。 設定可能な値は以下のとおりです。

  • Generic: ジェネリックシークレットを示します。
  • Rds: 管理対象のApsaraDB RDSシークレットを示します。
  • RAMCredentials: マネージRAMシークレットを示します。
  • ECS: マネージドECSシークレットを示します。
PlannedDeleteTime String 2022-03-21T15:45:12Z

シークレットが削除される予定の時刻。

DKMSInstanceId String kst-bjj62d8f5e0sgtx8h ****

専用KMSインスタンスのID。

タグ タグの配列

シークレットのリソースタグ。

FetchTagsパラメーターをfalseに設定した場合、またはFetchTagsパラメーターを指定しない場合、このパラメーターは返されません。

タグ
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>2020-02-21T15:39:26Z</UpdateTime>
    <CreateTime>2020-02-21T15:39:26Z</CreateTime>
    <NextRotationDate>2020-07-06T18:22:03Z</NextRotationDate>
    <EncryptionKeyId>00aa68af-2c02-4f68-95fe-3435d330 ****</EncryptionKeyId>
    <RotationInterval>3153600秒 </RotationInterval>
    <Arn>acs:kms:cn-hangzhou:154035569884 ****:secret/secret001</Arn>
    <ExtendedConfig >{\ "SecretSubType\":\"SingleUser\", \"DBInstanceId\":\"rm-uf667446pc955 ****\", \"CustomData\" :{} }</ExtendedConfig>
    <LastRotationDate>2020-07-05T08:22:03Z</LastRotationDate>
    <RequestId>93348dfb-3627-4417-8d90-487a76a909c9</RequestId>
    <Description>userinfo</Description>
    <SecretName>secret001</SecretName>
    <AutomaticRotation> 有効 </AutomaticRotation>
    <SecretType>Rds</SecretType>
    <PlannedDeleteTime>2020-03-21T15:45:12Z</PlannedDeleteTime>
    <DKMSInstanceId>kst-bjj62d8f5e0sgtx8h ****</DKMSInstanceId>
    <タグ>
        <TagValue>val1</TagValue>
        <TagKey>key1</TagKey>
    </タグ>
</DescribeSecretResponse>

JSON 形式 

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

{
  "UpdateTime" : "2020-02-21T15:39:26Z" 、
  "CreateTime" : "2020-02-21T15:39:26Z" 、
  "NextRotationDate" : "2020-07-06T18:22:03Z" 、
  "EncryptionKeyId" : "00aa68af-2c02-4f68-95fe-3435d330 ****" 、
  "RotationInterval" : "3153600s" 、
  "Arn" : "acs:kms:cn-hangzhou:154035569884 ****:secret/secret001" 、
  "ExtendedConfig" : "{\\\" SecretSubType \\\ ":\\\" SingleUser \\\ "、\\\" DBInstanceId \\\ ":\\\" rm-uf667446pc955 **** \\\ "、\\\\" CustomData \\\ \":{} }" 、
  "LastRotationDate" : "2020-07-05T08:22:03Z" 、
  "RequestId" : "93348dfb-3627-4417-8d90-487a76a909c9" 、
  "Description" : "userinfo" 、
  "SecretName" : "secret001" 、
  "AutomaticRotation" : "有効" 、
  "SecretType" : "Rds" 、
  "PlannedDeleteTime" : "2020-03-21T15:45:12Z" 、
  "DKMSInstanceId" : "kst-bjj62d8f5e0sgtx8h ****" 、
  "タグ" : [ {
    "TagValue" : "val1" 、
    "TagKey" : "key1"
  } ]
}

エラーコード

エラーコードリストについては、「API エラーセンター」をご参照ください。