Queries the information about data caches.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| eci:DescribeDataCaches | list | *DataCache acs:eci:{#regionId}:{#accountId}:datacache/{#datacacheId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The region ID of the data caches that you want to query. | cn-hangzhou |
| DataCacheId | array | No | The data cache IDs. | |
| string | No | The data cache ID. | edc-bp1a7n7uawwwol****** | |
| Bucket | string | No | The bucket that stores the data cache. Default value: default. | default |
| Path | string | No | The virtual host (vHost) directory in which the data cache resides. | /data/models/ |
| Tag | array<object> | No | The tags that are attached to the data cache. | |
| object | No | |||
| Key | string | No | The tag key. | testkey |
| Value | string | No | The tag value. | testvalue |
| ResourceGroupId | string | No | The ID of the resource group to which the data cache belongs. | rg-acfmzw2jz2z**** |
| Limit | integer | No | The maximum entries of query results that are allowed to be displayed. Valid values: 1 to 20. Default value: 20. | 20 |
| NextToken | string | No | The query token. Set the value to the NextToken value that is returned in the previous call. | d78f2dd8-5979-42fe-****-b16db43be5bc |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "B8756BA0-6452-419C-9727-37A6209C85E0",
"DataCaches": [
{
"DataCacheId": "edc-bp15l4vvys94oo******\n",
"CreationTime": "2023-06-16T02:43Z",
"Status": "Available",
"Progress": "100%",
"LastMatchedTime": "2023-06-18T02:43Z",
"ExpireDateTime": "2023-06-26T02:43Z\n",
"ContainerGroupId": "eci-8vb1y2w1dv7zeirn****",
"Tags": [
{
"Key": "testkey",
"Value": "testvalue"
}
],
"Events": [
{
"Type": "Normal",
"LastTimestamp": "2021-06-16T02:24:48Z",
"Message": "Successfully check data cache resource.",
"Name": "datacache",
"Count": 1,
"FirstTimestamp": "2021-06-16T02:14:48Z",
"Reason": "Started"
}
],
"RegionId": "cn-hangzhou",
"SnapshotId": "s-2zec5oj8e1yhxijt****",
"FlashSnapshotId": "s-bp12w3v37sit96t6****\n",
"ResourceGroupId": "rg-aek2hlt3ux4****",
"Size": 20,
"Name": "test",
"DataSource": {
"Type": "URL",
"Options": "{\n \"options\": {\n \"path\": \"/\",\n \"server\": \"0ce1f4****-or***.cn-hangzhou.nas.aliyuncs.com\",\n \"vers\": \"3\",\n \"options\": \"nolock,proto=tcp,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2,noresvport\"\n },\n \"type\": \"NAS\"\n}"
},
"Bucket": "default",
"Path": "/data/models/"
}
],
"NextToken": "d78f2dd8-5979-42fe-xaee-b16db43be5bc",
"TotalCount": 2
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | Account.Arrearage | Your account has an outstanding payment. | Your account has an outstanding payment. |
| 400 | DryRunOperation | Request validation has been passed with DryRun flag set. | Request validation has been passed with DryRun flag set. |
| 400 | ServiceNotEnabled | %s | You have not activated the service that is required for processing this request. |
| 403 | Forbidden.SubUser | The specified action is not available for you. | The specified action is not available for you. |
| 403 | Forbidden.UserBussinessStatus | This operation is not allowed, because you have overdue bills. Pay the overdue bill and try again. | - |
| 403 | Forbidden.UserNotRealNameAuthentication | This operation is not allowed, because you have not passed the real-name verification. | - |
| 403 | NoPermission | The RAM role does not belong to ECS. | - |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2023-09-05 | The Error code has changed. The response structure of the API has changed | View Change Details |