DescribeDataCaches - Elastic Container Instance - Alibaba Cloud Documentation Center

Queries the details of one or more data caches.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

eci:DescribeDataCaches

list

*DataCache

acs:eci:{#regionId}:{#accountId}:datacache/{#datacacheId}

eci:tag

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
RegionId	string	Yes	The region ID.	cn-hangzhou
DataCacheId	array	No	The data cache ID.
	string	No	The data cache ID.	edc-bp1a7n7uawwwol******
Bucket	string	No	The bucket of the data cache. The default value is default.	default
Path	string	No	The directory in the virtual host that corresponds to the data cache.	/data/models/
Tag	array<object>	No	The list of tags.
	object	No	The list of tags.
Key	string	No	The tag key.	testkey
Value	string	No	The tag value.	testvalue
ResourceGroupId	string	No	The resource group ID.	rg-acfmzw2jz2z****
Limit	integer	No	The maximum number of entries to return on a single page. The default value and the maximum value are both 20.	20
NextToken	string	No	The query token. Set this to the NextToken value returned from the previous API call.	d78f2dd8-5979-42fe-****-b16db43be5bc

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	B8756BA0-6452-419C-9727-37A6209C85E0
DataCaches	array<object>	The information about the data caches.
	array<object>	The information about the data caches.
DataCacheId	string	The data cache ID.	edc-bp15l4vvys94oo******
CreationTime	string	The time when the data cache was created.	2023-06-16T02:43Z
Status	string	The status of the data cache. Valid values: Loading: The data is being cached. Creating: The data cache is being created. Available: The data cache is created. Failed: The data cache failed to be created. Updating: The data cache is being updated. UpdateFailed: The data cache failed to be updated. You can use the data cache only when it is in the Available state.	Available
Progress	string	The creation progress.	100%
LastMatchedTime	string	The last time when the data cache was matched.	2023-06-18T02:43Z
ExpireDateTime	string	The expiration time.	2023-06-26T02:43Z
ContainerGroupId	string	The ID of the ECI instance that is generated during the creation of the data cache.	eci-8vb1y2w1dv7zeirn****
Tags	array<object>	The list of tags.
	object	The list of tags.
Key	string	The tag key.	testkey
Value	string	The tag value.	testvalue
Events	array<object>	The list of events.
	object	The list of events.
Type	string	The event type. Valid values: Normal Warning	Normal
LastTimestamp	string	The time when the event ended.	2021-06-16T02:24:48Z
Message	string	The event message.	Successfully check data cache resource.
Name	string	The event name.	datacache
Count	integer	The number of events.	1
FirstTimestamp	string	The time when the event started.	2021-06-16T02:14:48Z
Reason	string	The event reason.	Started
RegionId	string	The region ID.	cn-hangzhou
SnapshotId	string	The snapshot ID.	s-2zec5oj8e1yhxijt****
FlashSnapshotId	string	The local snapshot ID.	s-bp12w3v37sit96t6****
ResourceGroupId	string	The resource group ID.	rg-aek2hlt3ux4****
Size	integer	The size of the data cache. Unit: GiB.	20
Name	string	The name of the data cache.	test
DataSource	object	The data source information.
Type	string	The type of the data source. Valid values: NAS OSS URL SNAPSHOT	URL
Options	string	The parameters that are configured for the data source.	{ "options": { "path": "/", "server": "0ce1f4**-or*.cn-hangzhou.nas.aliyuncs.com", "vers": "3", "options": "nolock,proto=tcp,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2,noresvport" }, "type": "NAS" }
Bucket	string	The bucket of the data cache.	default
Path	string	The directory in the virtual host that corresponds to the data cache.	/data/models/
NextToken	string	The query token. Set this to the NextToken value returned from the previous API call.	d78f2dd8-5979-42fe-xaee-b16db43be5bc
TotalCount	integer	The total number of entries that match the query conditions.	2

Examples

Success response

JSON format

{
  "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	The service on which this request depends has not been activated. Please activate and try again.
403	Forbidden.SubUser	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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.