All Products
Search

This Product

    Key Management Service:DescribeSecret

    Document Center

    Key Management Service:DescribeSecret

    Last Updated:Dec 21, 2025

    Mengambil metadata sebuah secret.

    Deskripsi operasi

    Operasi ini mengembalikan metadata sebuah secret, tetapi tidak mengembalikan nilainya.

    Pada contoh ini, metadata secret bernama secret001 diambil.

    Coba sekarang

    Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

    Test

    RAM authorization

    Tidak ada otorisasi untuk operasi ini. Jika Anda mengalami masalah saat menjalankan operasi ini, hubungi dukungan teknis.

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    SecretName

    string

    Yes

    Nama secret.

    secret001
    FetchTags

    string

    No

    Menentukan apakah tag resource secret dikembalikan. Nilai yang valid:

    • true: Tag resource dikembalikan.

    • false: Tag resource tidak dikembalikan. Ini adalah nilai default.

    true

    Untuk informasi selengkapnya tentang parameter permintaan umum, lihat Common parameters.

    Elemen respons

    Element

    Type

    Description

    Example

    object

    UpdateTime

    string

    Waktu saat secret diperbarui.

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

    string

    Waktu saat secret dibuat.

    2022-02-21T15:39:26Z
    NextRotationDate

    string

    Waktu rotasi berikutnya akan dilakukan.

    Catatan

    Parameter ini dikembalikan ketika rotasi otomatis diaktifkan.

    2022-07-06T18:22:03Z
    EncryptionKeyId

    string

    ID customer master key (CMK) yang digunakan untuk mengenkripsi nilai secret.

    00aa68af-2c02-4f68-95fe-3435d330****
    RotationInterval

    string

    Interval rotasi otomatis.

    Nilainya dalam format integer[unit]. integer menunjukkan durasi waktu. unit: menunjukkan satuan waktu. Nilai unit tetap sebagai s. Misalnya, jika nilainya 604800s, rotasi otomatis dilakukan setiap 7 hari.

    Catatan

    Parameter ini dikembalikan ketika rotasi otomatis diaktifkan.

    3153600s
    Arn

    string

    Alibaba Cloud Resource Name (ARN) dari secret tersebut.

    acs:kms:cn-hangzhou:154035569884****:secret/secret001
    ExtendedConfig

    string

    Konfigurasi tambahan dari secret tersebut.

    Catatan

    Parameter ini hanya dikembalikan untuk secret ApsaraDB RDS terkelola, secret Resource Access Management (RAM) terkelola, atau secret Elastic Compute Service (ECS) terkelola.

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

    string

    Waktu rotasi terakhir dilakukan.

    Catatan

    Parameter ini dikembalikan jika secret telah diputar.

    2022-07-05T08:22:03Z
    RequestId

    string

    ID permintaan, yang digunakan untuk melacak dan memecahkan masalah.

    93348dfb-3627-4417-8d90-487a76a909c9
    Description

    string

    Deskripsi secret tersebut.

    userinfo
    SecretName

    string

    Nama secret tersebut.

    secret001
    AutomaticRotation

    string

    Menunjukkan apakah rotasi otomatis diaktifkan. Nilai yang valid:

    • Enabled: menunjukkan bahwa rotasi otomatis diaktifkan.

    • Disabled: menunjukkan bahwa rotasi otomatis dinonaktifkan.

    • Invalid: menunjukkan bahwa status rotasi otomatis tidak normal. Dalam kasus ini, Secrets Manager tidak dapat memutar secret secara otomatis.

    Catatan

    Parameter ini hanya dikembalikan untuk secret ApsaraDB RDS terkelola, secret RAM terkelola, atau secret ECS terkelola.

    Enabled
    SecretType

    string

    Jenis secret tersebut. Nilai yang valid:

    • Generic: menunjukkan secret generik.

    • Rds: menunjukkan secret ApsaraDB RDS terkelola.

    • RAMCredentials: menunjukkan secret RAM terkelola.

    • ECS: menunjukkan secret ECS terkelola.

    Rds
    PlannedDeleteTime

    string

    Waktu saat secret dijadwalkan untuk dihapus.

    2022-03-21T15:45:12Z
    DKMSInstanceId

    string

    ID instans KMS khusus.

    kst-bjj62d8f5e0sgtx8h****
    Tags

    object

    Tag

    array<object>

    Tag resource dari secret tersebut.

    Parameter ini tidak dikembalikan jika Anda mengatur parameter FetchTags ke false atau tidak menentukan parameter FetchTags.

    object

    TagValue

    string

    Nilai tag.

    val1
    TagKey

    string

    Kunci tag.

    key1

    Contoh

    Respons sukses

    JSONformat

    {
  "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"
      }
    ]
  }
}

    Kode kesalahan

    HTTP status code

    Error code

    Error message

    Description
    400 IllegalTimestamp The input parameter Timestamp that is mandatory for processing this request is not supplied. The input parameter timestamp indicates that the request is outside the processing time range.
    400 InvalidParameter The specified parameter is not valid. An invalid value is specified for the parameter.
    403 Forbidden.NoPermission You are not authorized to perform the operation. 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.

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.