All Products
Search
Document Center

Database Autonomy Service:DescribeCacheAnalysisJob

Last Updated:Jun 10, 2026

Mengembalikan detail tugas analisis cache.

Deskripsi operasi

Before you call this operation, take note of the following items:

  • If you use an Alibaba Cloud SDK or a Database Autonomy Service (DAS) SDK to call this operation, we recommend that you use the latest version of the SDK.

  • If you use an SDK to call the API operations of DAS, you must set the region ID to cn-shanghai.

  • This operation is applicable only to ApsaraDB for Redis.

Catatan

Returns the top 500 keys in a cache analysis task.

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

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

  • Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.

  • API: API yang dapat Anda panggil untuk melakukan aksi tersebut.

  • Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.

  • Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.

    • Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.

    • Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.

  • Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.

  • Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

hdm:DescribeCacheAnalysisJob

get

*全部资源

*

None None

Parameter permintaan

Parameter

Type

Required

Description

Example

InstanceId

string

Yes

ID instans.

r-bp18ff4a195d****

JobId

string

Yes

ID tugas analisis cache. Anda dapat memperoleh ID tugas dari parameter tanggapan operasi CreateCacheAnalysisJob.

sf79-sd99-sa37-****

Elemen respons

Element

Type

Description

Example

object

The response parameters.

Message

string

The message that is returned for the request.

Catatan

If the request is successful, Successful is returned. If the request fails, an error message that contains information such as an error code is returned.

Successful

RequestId

string

The ID of the request.

B6D17591-B48B-4D31-9CD6-9B9796B2****

Data

object

The details of the cache analysis task.

TaskState

string

The state of the cache analysis task. Valid values:

  • BACKUP: The data is being backed up.

  • ANALYZING: The data is being analyzed.

  • FINISHED: The data is analyzed.

  • FAILED: An error occurred.

BACKUP

JobId

string

The ID of the cache analysis task.

sf79-sd99-sa37-****

Message

string

The message that is returned for the request.

Catatan

If the request is successful, Successful is returned. If the request fails, an error message that contains information such as an error code is returned.

Successful

BigKeys

object

KeyInfo

array<object>

The details of the large keys. The returned large keys are sorted in descending order based on the number of bytes occupied by the keys.

object

Type

string

The data type of the instance.

hash

Db

integer

The database name.

0

ExpirationTimeMillis

integer

The time when the key expires. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. A value of 0 indicates that the key never expires.

1596256542547

Key

string

The key name.

task_x****

Encoding

string

The data type of the key.

hashtable

Bytes

integer

The number of bytes that are occupied by the key.

12345

NodeId

string

The ID of the data node on the instance.

r-x****-db-0

Count

integer

The number of elements in the key.

127

KeyPrefixes

object

Prefix

array<object>

The prefixes of the keys.

object

KeyNum

integer

The number of keys that contain the prefix.

123

Type

string

The data type of the instance.

hash

Bytes

integer

The number of bytes that are occupied by the key.

12345

Prefix

string

The prefix of the key.

task_

Count

integer

The number of elements in the key.

127

BigKeysOfNum

object

KeyInfo

array<object>

The details of the large keys. The returned large keys are sorted in descending order based on the number of keys.

object

Type

string

The data type of the instance.

hash

Db

integer

The database name.

0

ExpirationTimeMillis

integer

The time when the key expires. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. A value of 0 indicates that the key never expires.

1596256542547

Key

string

The key name.

task_x****

Encoding

string

The data type of the key.

hashtable

Bytes

integer

The number of bytes that are occupied by the key.

12345

NodeId

string

The ID of the data node on the instance.

r-x****-db-0

Count

integer

The number of elements in the key.

127

UnexBigKeysOfBytes

object

KeyInfo

array<object>

The details of permanent keys. The returned keys are sorted in descending order based on the number of bytes occupied by the keys.

object

Type

string

The data type of the instance.

hash

Db

integer

The database name.

0

ExpirationTimeMillis

integer

The time when the key expires. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. A value of 0 indicates that the key never expires.

1596256542547

Key

string

The key name.

task_x****

Encoding

string

The data type of the key.

hashtable

Bytes

integer

The number of bytes that are occupied by the key.

12345

NodeId

string

The ID of the data node on the instance.

r-x****-db-0

Count

integer

The number of elements in the key.

127

UnexBigKeysOfNum

object

KeyInfo

array<object>

The details of permanent keys. The returned keys are sorted in descending order based on the number of keys.

object

Type

string

The data type of the instance.

hash

Db

integer

The database name.

0

ExpirationTimeMillis

integer

The time when the key expires. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. A value of 0 indicates that the key never expires.

1596256542547

Key

string

The key name.

task_x****

Encoding

string

The data type of the key.

hashtable

Bytes

integer

The number of bytes that are occupied by the key.

12345

NodeId

string

The ID of the data node on the instance.

r-x****-db-0

Count

integer

The number of elements in the key.

127

InstanceId

string

The instance ID.

r-bp18ff4a195d****

NodeId

string

The ID of the data node on the instance.

r-x****-db-0

ExpiryKeysLevelCount

object

ExpiryLevel

array<object>

The statistics of the keys that have expired.

object

AnalysisTs

integer

The time when the cache analysis task was complete. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

1717469347000

Level

integer

The expiration level. Valid values:

  • 0: The key never expires.

  • 1: The key has expired.

  • 2: The key has expired for 0 to 1 hour.

  • 3: The key has expired for 1 to 3 hours.

  • 4: The key has expired for 3 to 12 hours.

  • 5: The key has expired for 12 to 24 hours.

  • 6: The key has expired for one to two days.

  • 7: The key has expired for three to seven days.

  • 8: The key has expired for more than seven days.

0

TotalBytes

integer

The number of bytes occupied by the keys that have expired.

8064

TotalKeys

integer

The total number of the keys that have expired.

62

Code

string

The HTTP status code returned.

200

Success

string

Indicates whether the request was successful. Valid values:

  • true

  • false

true

Contoh

Respons sukses

JSONformat

{
  "Message": "Successful",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Data": {
    "TaskState": "BACKUP",
    "JobId": "sf79-sd99-sa37-****",
    "Message": "Successful",
    "BigKeys": {
      "KeyInfo": [
        {
          "Type": "hash",
          "Db": 0,
          "ExpirationTimeMillis": 1596256542547,
          "Key": "task_x****",
          "Encoding": "hashtable",
          "Bytes": 12345,
          "NodeId": "r-x****-db-0",
          "Count": 127
        }
      ]
    },
    "KeyPrefixes": {
      "Prefix": [
        {
          "KeyNum": 123,
          "Type": "hash",
          "Bytes": 12345,
          "Prefix": "task_",
          "Count": 127
        }
      ]
    },
    "BigKeysOfNum": {
      "KeyInfo": [
        {
          "Type": "hash",
          "Db": 0,
          "ExpirationTimeMillis": 1596256542547,
          "Key": "task_x****",
          "Encoding": "hashtable",
          "Bytes": 12345,
          "NodeId": "r-x****-db-0",
          "Count": 127
        }
      ]
    },
    "UnexBigKeysOfBytes": {
      "KeyInfo": [
        {
          "Type": "hash",
          "Db": 0,
          "ExpirationTimeMillis": 1596256542547,
          "Key": "task_x****",
          "Encoding": "hashtable",
          "Bytes": 12345,
          "NodeId": "r-x****-db-0",
          "Count": 127
        }
      ]
    },
    "UnexBigKeysOfNum": {
      "KeyInfo": [
        {
          "Type": "hash",
          "Db": 0,
          "ExpirationTimeMillis": 1596256542547,
          "Key": "task_x****",
          "Encoding": "hashtable",
          "Bytes": 12345,
          "NodeId": "r-x****-db-0",
          "Count": 127
        }
      ]
    },
    "InstanceId": "r-bp18ff4a195d****",
    "NodeId": "r-x****-db-0",
    "ExpiryKeysLevelCount": {
      "ExpiryLevel": [
        {
          "AnalysisTs": 1717469347000,
          "Level": 0,
          "TotalBytes": 8064,
          "TotalKeys": 62
        }
      ]
    }
  },
  "Code": "200",
  "Success": "true"
}

Kode kesalahan

HTTP status code

Error code

Error message

Description

400 InvalidParams The request parameters are invalid.
403 NoPermission You are not authorized to do this action.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.