シークレットのメタデータを照会します。
操作説明
この操作はシークレットのメタデータを返します。この操作はシークレット値を返しません。
この例では、secret001 という名前のシークレットのメタデータを照会します。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| SecretName |
string |
必須 |
シークレットの名前。 |
secret001 |
| FetchTags |
string |
任意 |
シークレットのリソースタグを返すかどうかを指定します。有効な値：
|
true |
共通リクエストパラメーターの詳細については、「共通パラメーター」をご参照ください。
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| UpdateTime |
string |
シークレットが更新された時刻。 |
2022-02-21T15:39:26Z |
| CreateTime |
string |
シークレットが作成された時刻。 |
2022-02-21T15:39:26Z |
| NextRotationDate |
string |
次回のローテーションが実行される時刻。 説明
このパラメーターは、自動ローテーションが有効な場合に返されます。 |
2022-07-06T18:22:03Z |
| EncryptionKeyId |
string |
シークレット値の暗号化に使用されるカスタマーマスターキー (CMK) の ID。 |
00aa68af-2c02-4f68-95fe-3435d330**** |
| RotationInterval |
string |
自動ローテーションの間隔。 値は 説明
このパラメーターは、自動ローテーションが有効な場合に返されます。 |
3153600s |
| Arn |
string |
シークレットの Alibaba Cloud リソースネーム (ARN)。 |
acs:kms:cn-hangzhou:154035569884****:secret/secret001 |
| ExtendedConfig |
string |
シークレットの拡張設定。 説明
このパラメーターは、マネージド ApsaraDB RDS シークレット、マネージド Resource Access Management (RAM) シークレット、またはマネージド Elastic Compute Service (ECS) シークレットの場合にのみ返されます。 |
{\"SecretSubType\":\"SingleUser\", \"DBInstanceId\":\"rm-uf667446pc955****\", \"CustomData\":{} } |
| LastRotationDate |
string |
最後のローテーションが実行された時刻。 説明
このパラメーターは、シークレットがローテーションされた場合に返されます。 |
2022-07-05T08:22:03Z |
| RequestId |
string |
リクエスト ID。問題の特定とトラブルシューティングに使用されます。 |
93348dfb-3627-4417-8d90-487a76a909c9 |
| Description |
string |
シークレットの説明。 |
userinfo |
| SecretName |
string |
シークレットの名前。 |
secret001 |
| AutomaticRotation |
string |
自動ローテーションが有効かどうかを示します。有効な値：
説明
このパラメーターは、マネージド ApsaraDB RDS シークレット、マネージド RAM シークレット、またはマネージド ECS シークレットの場合にのみ返されます。 |
Enabled |
| SecretType |
string |
シークレットのタイプ。有効な値：
|
Rds |
| PlannedDeleteTime |
string |
シークレットが削除される予定時刻。 |
2022-03-21T15:45:12Z |
| DKMSInstanceId |
string |
専用 KMS インスタンスの ID。 |
kst-bjj62d8f5e0sgtx8h**** |
| Tags |
object |
||
| Tag |
array<object> |
シークレットのリソースタグ。 FetchTags パラメーターを false に設定した場合、または FetchTags パラメーターを指定しなかった場合、このパラメーターは返されません。 |
|
|
object |
|||
| TagValue |
string |
タグ値。 |
val1 |
| TagKey |
string |
タグキー。 |
key1 |
例
成功レスポンス
JSONJSON
{
"UpdateTime": "2022-02-21T15:39:26Z",
"CreateTime": "2022-02-21T15:39:26Z",
"NextRotationDate": "2022-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": "2022-07-05T08:22:03Z",
"RequestId": "93348dfb-3627-4417-8d90-487a76a909c9",
"Description": "userinfo",
"SecretName": "secret001",
"AutomaticRotation": "Enabled",
"SecretType": "Rds",
"PlannedDeleteTime": "2022-03-21T15:45:12Z",
"DKMSInstanceId": "kst-bjj62d8f5e0sgtx8h****",
"Tags": {
"Tag": [
{
"TagValue": "val1",
"TagKey": "key1"
}
]
}
}エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | IllegalTimestamp | The input parameter Timestamp that is mandatory for processing this request is not supplied. | リクエストを処理するための必須パラメータ「Timestamp」は提供されていません。 |
| 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. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。