文档

DescribeDataCaches - 查询数据缓存

更新时间:

查询数据缓存信息。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
eci:DescribeDataCachesList
  • DataCache
    acs:eci:{#regionId}:{#accountId}:datacache/{#datacacheId}
  • eci:tag

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。

cn-hangzhou
DataCacheIdarray

数据缓存 ID。

string

数据缓存 ID。

edc-bp1a7n7uawwwol******
Bucketstring

数据缓存 Bucket。默认为 default。

default
Pathstring

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

/data/models/
Tagobject []

标签列表。

Keystring

标签键。

testkey
Valuestring

标签值。

testvalue
ResourceGroupIdstring

资源组 ID。

rg-acfmzw2jz2z****
Limitinteger

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

20
NextTokenstring

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

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

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

B8756BA0-6452-419C-9727-37A6209C85E0
DataCachesobject []

数据缓存信息。

DataCacheIdstring

数据缓存 ID。

edc-bp15l4vvys94oo******
CreationTimestring

创建时间。

2023-06-16T02:43Z
Statusstring

数据缓存状态。可能值:

  • Loading:缓存数据中
  • Creating:创建中
  • Available:创建成功
  • Failed:创建失败
  • Updating:更新中
  • UpdateFailed:更新失败

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

Ready
Progressstring

创建进度。

100%
LastMatchedTimestring

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

2023-06-18T02:43Z
ExpireDateTimestring

到期时间。

2023-06-26T02:43Z
ContainerGroupIdstring

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

eci-8vb1y2w1dv7zeirn****
Tagsobject []

标签列表。

Keystring

标签键。

testkey
Valuestring

标签值。

testvalue
Eventsobject []

事件列表。

Typestring

事件类型。可能值:

  • Normal
  • Warning
Normal
LastTimestampstring

事件结束时间。

2021-06-16T02:24:48Z
Messagestring

事件信息。

Successfully check data cache resource.
Namestring

事件名称。

datacache
Countinteger

事件数。

1
FirstTimestampstring

事件开始时间。

2021-06-16T02:14:48Z
Reasonstring

事件原因。

Started
RegionIdstring

地域 ID。

cn-hangzhou
SnapshotIdstring

快照 ID。

s-2zec5oj8e1yhxijt****
FlashSnapshotIdstring

本地快照 ID。

s-bp12w3v37sit96t6****
ResourceGroupIdstring

资源组 ID。

rg-aek2hlt3ux4****
Sizeinteger

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

20
Namestring

数据缓存名称。

test
DataSourceobject

数据源信息。

Typestring

数据源类型。可能值:

  • NAS
  • OSS
  • URL
  • SNAPSHOT
URL
Optionsstring

数据源的配置参数。

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

数据缓存 Bucket。

default
Pathstring

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

/data/models/
NextTokenstring

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

d78f2dd8-5979-42fe-xaee-b16db43be5bc
TotalCountinteger

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

2

示例

正常返回示例

JSON格式

{
  "RequestId": "B8756BA0-6452-419C-9727-37A6209C85E0",
  "DataCaches": [
    {
      "DataCacheId": "edc-bp15l4vvys94oo******\n",
      "CreationTime": "2023-06-16T02:43Z",
      "Status": "Ready",
      "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错误码错误信息描述
400Account.ArrearageYour account has an outstanding payment.账号已经欠费。
400DryRunOperationRequest validation has been passed with DryRun flag set.此次DryRun预检请求合格。
400ServiceNotEnabled%s该次请求所依赖的服务没有开通,请开通后再试。
403Forbidden.SubUserThe specified action is not available for you.当前用户无法执行该操作。
403Forbidden.UserBussinessStatusThis operation is not allowed, because you have overdue bills. Pay the overdue bill and try again.用户处于欠费状态不允许创建,请充值后再尝试。
403Forbidden.UserNotRealNameAuthenticationThis operation is not allowed, because you have not passed the real-name verification.操作被禁止,因为用户还未进行实名认证。
403NoPermissionThe RAM role does not belong to ECS.-

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

变更历史

变更时间变更内容概要操作
2023-09-05OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈