All Products
Search

This Product

    Key Management Service:DescribeSecret

    Document Center

    Key Management Service:DescribeSecret

    Last Updated:Jun 10, 2026

    Mengkueri metadata dari sebuah secret.

    Deskripsi operasi

    Operasi ini mengembalikan metadata dari sebuah secret. Operasi ini tidak mengembalikan nilai secret.

    Dalam contoh ini, metadata dari secret bernama secret001 dikueri.

    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 akan mengembalikan tag resource dari secret. Nilai yang valid:

    • true: Tag resource dikembalikan.

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

    true

    Untuk informasi lebih lanjut tentang parameter request umum, lihat Parameter umum.

    Elemen respons

    Element

    Type

    Description

    Example

    object

    UpdateTime

    string

    Waktu ketika secret diperbarui.

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

    string

    Waktu ketika secret dibuat.

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

    string

    Waktu ketika rotasi berikutnya akan dilakukan.

    Catatan

    Parameter ini dikembalikan ketika rotasi otomatis diaktifkan.

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

    string

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

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

    string

    Interval untuk rotasi otomatis.

    Nilai berada dalam format integer[unit]. integer menunjukkan panjang waktu. unit: menunjukkan satuan waktu. Nilai unit ditetapkan sebagai s. Misalnya, jika nilainya 604800s, rotasi otomatis dilakukan pada interval 7 hari.

    Catatan

    Parameter ini dikembalikan ketika rotasi otomatis diaktifkan.

    3153600s
    Arn

    string

    Alibaba Cloud Resource Name (ARN) dari secret.

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

    string

    Konfigurasi extended dari secret.

    Catatan

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

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

    string

    Waktu ketika rotasi terakhir dilakukan.

    Catatan

    Parameter ini dikembalikan jika secret telah dirotasi.

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

    string

    ID dari request, yang digunakan untuk mencari dan memecahkan masalah.

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

    string

    Deskripsi dari secret.

    userinfo
    SecretName

    string

    Nama secret.

    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 abnormal. Dalam kasus ini, Secrets Manager tidak dapat merotasi secret secara otomatis.

    Catatan

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

    Enabled
    SecretType

    string

    Tipe dari secret. Nilai yang valid:

    • Generic: menunjukkan secret generik.

    • Rds: menunjukkan secret ApsaraDB RDS yang dikelola.

    • RAMCredentials: menunjukkan secret RAM yang dikelola.

    • ECS: menunjukkan secret ECS yang dikelola.

    Rds
    PlannedDeleteTime

    string

    Waktu ketika secret dijadwalkan untuk dihapus.

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

    string

    ID dari instance KMS dedicated.

    kst-bjj62d8f5e0sgtx8h****
    Tags

    object

    Tag

    array<object>

    Tag resource dari secret.

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

    object

    TagValue

    string

    The tag value.

    val1
    TagKey

    string

    The tag key.

    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.