DescribeDataCaches - 查询数据缓存

查询数据缓存信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

eci:DescribeDataCaches

list

*DataCache

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

  • eci:tag

请求参数

名称

类型

必填

描述

示例值

RegionId

string

地域 ID。

cn-hangzhou

RegionId

string

地域 ID。

cn-hangzhou

DataCacheId

array

数据缓存 ID。

string

数据缓存 ID。

edc-bp1a7n7uawwwol******

Bucket

string

数据缓存 Bucket。默认为 default。

default

Path

string

数据缓存对应 Virtual Host 的目录。

/data/models/

Tag

array<object>

标签列表。

object

标签列表

Key

string

标签键。

testkey

Value

string

标签值。

testvalue

ResourceGroupId

string

资源组 ID。

rg-acfmzw2jz2z****

Limit

integer

查询结果条数上限。默认值和最大值为 20。

20

NextToken

string

查询凭证(Token),取值为上一次 API 调用返回的 NextToken 参数值。

d78f2dd8-5979-42fe-****-b16db43be5bc

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

B8756BA0-6452-419C-9727-37A6209C85E0

DataCaches

array<object>

数据缓存信息。

array<object>

数据缓存信息。

DataCacheId

string

数据缓存 ID。

edc-bp15l4vvys94oo******

CreationTime

string

创建时间。

2023-06-16T02:43Z

Status

string

数据缓存状态。可能值:

  • Loading:缓存数据中

  • Creating:创建中

  • Available:创建成功

  • Failed:创建失败

  • Updating:更新中

  • UpdateFailed:更新失败

当状态为 Available 时,即可使用该数据缓存。

Available

Progress

string

创建进度。

100%

LastMatchedTime

string

最新一次匹配数据缓存的时间。

2023-06-18T02:43Z

ExpireDateTime

string

到期时间。

2023-06-26T02:43Z

ContainerGroupId

string

创建数据缓存过程中,生成的 ECI 实例 ID。

eci-8vb1y2w1dv7zeirn****

Tags

array<object>

标签列表。

object

标签列表。

Key

string

标签键。

testkey

Value

string

标签值。

testvalue

Events

array<object>

事件列表。

object

事件列表。

Type

string

事件类型。可能值:

  • Normal

  • Warning

Normal

LastTimestamp

string

事件结束时间。

2021-06-16T02:24:48Z

Message

string

事件信息。

Successfully check data cache resource.

Name

string

事件名称。

datacache

Count

integer

事件数。

1

FirstTimestamp

string

事件开始时间。

2021-06-16T02:14:48Z

Reason

string

事件原因。

Started

RegionId

string

地域 ID。

cn-hangzhou

SnapshotId

string

快照 ID。

s-2zec5oj8e1yhxijt****

FlashSnapshotId

string

本地快照 ID。

s-bp12w3v37sit96t6****

ResourceGroupId

string

资源组 ID。

rg-aek2hlt3ux4****

Size

integer

数据缓存大小。单位为 GiB。

20

Name

string

数据缓存名称。

test

DataSource

object

数据源信息。

Type

string

数据源类型。可能值:

  • NAS

  • OSS

  • URL

  • SNAPSHOT

URL

Options

string

数据源的配置参数。

{ "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

数据缓存 Bucket。

default

Path

string

数据缓存对应 Virtual Host 的目录。

/data/models/

NextToken

string

查询凭证(Token),取值为上一次 API 调用返回的 NextToken 参数值。

d78f2dd8-5979-42fe-xaee-b16db43be5bc

TotalCount

integer

符合查询条件的结果条数。

2

示例

正常返回示例

JSON格式

{
  "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
}

错误码

HTTP status code

错误码

错误信息

描述

400 Account.Arrearage Your account has an outstanding payment. 账号已经欠费。
400 DryRunOperation Request validation has been passed with DryRun flag set. 此次DryRun预检请求合格。
400 ServiceNotEnabled %s 该次请求所依赖的服务没有开通,请开通后再试。
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.

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情