文档

DescribeInstance - 获取数据集加速实例详情

更新时间:

获取指定数据集加速实例信息。

调试

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

授权信息

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

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

请求语法

GET /api/v1/instances/{InstanceId}

请求参数

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

数据集加速实例 ID。如何获取加速实例 ID,请参见 ListInstances

inst-my1tk3jggooi5u****

返回参数

名称类型描述示例值
object

返回值。

RequestIdstring

请求 ID。

A731A84D-55C9-44F7-99BB-E1CF0CF1****
UserIdstring

数据集加速实例的创建者的 Uid,在阿里云内为 RAM 用户 ID(阿里云账号创建则直接为阿里云账号 ID)。

27606534679741****
OwnerIdstring

数据集加速实例资源拥有者的 Uid,在阿里云内为阿里云账号 ID。

155770209819****
GmtCreateTimestring

数据集加速实例创建的时间。格式使用 ISO8601(RFC3339)。

2014-10-02T15:01:23Z
GmtModifiedTimestring

数据集加速实例最后更新的时间。格式使用 ISO8601(RFC3339)。

2014-10-02T15:01:23Z
Uuidstring

数据集加速实例的唯一标识符。

inst-my1tk3jggooi5u****
Namestring

数据集加速实例名称。

acc_instance_1
Descriptionstring

数据集加速实例的描述与解释。

xgboost数据集加速实例
Typestring

数据集加速实例的类型,可能值:

  • basic:基础版。
  • enhanced:增强版。
basic
Tagsobject []

用户为数据集加速实例添加的自定义标签。

Keystring

标签的键值。 长度限制为 64Unicode 字符。

dataset_version
Valuestring

标签的值。 长度限制为 64Unicode 字符。

v0.1.0
PaymentTypestring

数据集加速实例的付费类型,可能值:

  • PayAsYouGo:后付费(按量付费)。
  • Subscription:预付费(包年包月)。
PayAsYouGo
Capacitystring

数据集加速实例的最大容量。 输入字符串的格式需要满足以下规范: Quantity

30.0G
IoTypestring

数据集加速实例的读写类型。

readonly
MaxSlotinteger

数据集加速实例的最大加速槽个数。

20
MaxEndpointinteger

数据集加速实例的最大挂载点个数。

StorageTypestring

数据集加速实例的存储类型。

OSS
ProviderTypestring

数据集加速实例的资源提供者类型。

Ecs
StatusInstanceStatus

数据集加速实例状态。

示例

正常返回示例

JSON格式

{
  "RequestId": "A731A84D-55C9-44F7-99BB-E1CF0CF1****",
  "UserId": "27606534679741****",
  "OwnerId": "155770209819****",
  "GmtCreateTime": "2014-10-02T15:01:23Z",
  "GmtModifiedTime": "2014-10-02T15:01:23Z",
  "Uuid": "inst-my1tk3jggooi5u****",
  "Name": "acc_instance_1",
  "Description": "xgboost数据集加速实例",
  "Type": "basic",
  "Tags": [
    {
      "Key": "dataset_version",
      "Value": "v0.1.0"
    }
  ],
  "PaymentType": "PayAsYouGo",
  "Capacity": "30.0G",
  "IoType": "readonly",
  "MaxSlot": 20,
  "MaxEndpoint": 0,
  "StorageType": "OSS",
  "ProviderType": "Ecs",
  "Status": {
    "Phase": "Running",
    "Code": "200",
    "Message": "Init Succeed",
    "UsedCapacity": "20.0G",
    "SlotNum": 10
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-05-22OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-05-22OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更