调用DescribeCacheAnalysisJobs接口,查询缓存分析任务列表。
使用该接口需满足以下前提条件:
- 使用阿里云或DAS的SDK时,建议使用最新版本。
- 使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。
- 本接口只适用于Redis引擎。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeCacheAnalysisJobs | 系统规定参数。取值:DescribeCacheAnalysisJobs。 |
InstanceId | String | 是 | r-bp18ff4a195d**** | 实例ID。 |
StartTime | String | 是 | 1596177993000 | 查询任务开始时间,格式为Unix时间戳,单位为毫秒。 |
EndTime | String | 是 | 1596177993001 | 查询任务结束时间,格式为Unix时间戳,单位为毫秒。 说明 查询任务结束时间需晚于查询任务开始时间。 |
PageNo | String | 否 | 1 | 页码,取值大于0且不超过Integer数据类型的最大值,默认值为1。 |
PageSize | String | 否 | 10 | 每页最大记录数,默认值为10。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Message | String | Successful | 请求返回消息。 说明 请求成功时该参数返回Successful,请求失败时会返回请求异常信息(如错误码等)。 |
RequestId | String | B6D17591-B48B-4D31-9CD6-9B9796B2**** | 请求ID。 |
Data | Object | 信息列表。 |
|
List | Array of CacheAnalysisJob | 信息详情。 |
|
CacheAnalysisJob | |||
TaskState | String | BACKUP | 缓存分析任务的状态:
|
JobId | String | sf79-sd99-sa37-**** | 缓存分析任务ID。 |
Message | String | Successful | 请求返回消息。 说明 请求成功时该参数返回Successful,请求失败时会返回请求异常信息(如错误码等)。 |
BigKeys | Array of KeyInfo | 大Key详细信息。 重要 当前已不再返回该参数的子参数及其内容,请调用DescribeCacheAnalysisJob接口查询缓存分析任务的详细信息。
|
|
KeyInfo | |||
Type | String | hash | Redis数据结构类型。 |
Db | Integer | 0 | 数据库名称。 |
ExpirationTimeMillis | Long | 1596256542547 | Key过期时间,单位:毫秒(ms),0表示不过期。 |
Key | String | task_***** | Key的名称。 |
Encoding | String | hashtable | Key内部数据类型。 |
Bytes | Long | 12345 | Key占用字节数。 |
NodeId | String | r-****-db-0 | 实例的数据节点ID。 |
Count | Long | 127 | Key的元素个数。 |
InstanceId | String | r-bp18ff4a195d**** | 实例ID。 |
NodeId | String | r-x****-db-0 | 实例的数据节点ID。 |
PageNo | Long | 1 | 页码,取值大于0且不超过Integer数据类型的最大值,默认值为1。 |
PageSize | Long | 10 | 每页最大记录数,默认值为10。 |
Extra | String | None | 备用参数。 |
Total | Long | 4 | 结果数量。 |
Code | String | 200 | 返回的状态码。 |
Success | String | true | 请求是否执行成功:
|
示例
请求示例
http(s)://das.cn-shanghai.aliyuncs.com/?Action=DescribeCacheAnalysisJobs
&InstanceId=r-bp18ff4a195d****
&StartTime=1596177993000
&EndTime=1596177993001
&PageNo=1
&PageSize=10
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeCacheAnalysisJobsResponse>
<Message>Successful</Message>
<RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>
<Data>
<List>
<TaskState>BACKUP</TaskState>
<JobId>sf79-sd99-sa37-****</JobId>
<Message>Successful</Message>
<BigKeys>
<Type>hash</Type>
<Db>0</Db>
<ExpirationTimeMillis>1596256542547</ExpirationTimeMillis>
<Key>task_*****</Key>
<Encoding>hashtable</Encoding>
<Bytes>12345</Bytes>
<NodeId>r-****-db-0</NodeId>
<Count>127</Count>
</BigKeys>
<InstanceId>r-bp18ff4a195d****</InstanceId>
<NodeId>r-x****-db-0</NodeId>
</List>
<PageNo>1</PageNo>
<PageSize>10</PageSize>
<Extra>None</Extra>
<Total>4</Total>
</Data>
<Code>200</Code>
<Success>true</Success>
</DescribeCacheAnalysisJobsResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"Message" : "Successful",
"RequestId" : "B6D17591-B48B-4D31-9CD6-9B9796B2****",
"Data" : {
"List" : [ {
"TaskState" : "BACKUP",
"JobId" : "sf79-sd99-sa37-****",
"Message" : "Successful",
"BigKeys" : [ {
"Type" : "hash",
"Db" : 0,
"ExpirationTimeMillis" : 1596256542547,
"Key" : "task_*****",
"Encoding" : "hashtable",
"Bytes" : 12345,
"NodeId" : "r-****-db-0",
"Count" : 127
} ],
"InstanceId" : "r-bp18ff4a195d****",
"NodeId" : "r-x****-db-0"
} ],
"PageNo" : 1,
"PageSize" : 10,
"Extra" : "None",
"Total" : 4
},
"Code" : "200",
"Success" : "true"
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidParams | The request parameters are invalid. | 请求参数错误 |
访问错误中心查看更多错误码。