文档

DescribeComponent - 获取数据集加速组件详情

更新时间:

获取指定数据集加速组件的信息。

调试

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

授权信息

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

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

请求语法

GET /api/v1/components/{ComponentId}

请求参数

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

数据集加速组件 ID。如何获取组件 ID,请参见 ListComponents

cmpt-my1tk3jggooi5uwks5
RenderTemplateboolean

是否对组件模板进行渲染并展示。 如果值为 true,则返回中包含模板渲染后的内容。

说明 只支持指定组件列表: dataset-accelerator 返回的组件模板内容最大长度为 4096 Byte,超过最大长度会对模板进行截断。
true
Valuesobject

组件模板渲染时使用的参数。

any

组件的属性值。

{\"frontEndPort\":\"24457\",\"endpointId\":\"end-mlpo5mrygduwl9lm31\",\"frontEndAddr\":\"192.168.0.3\",\"slotId\":\"slot-vas3b1ygg22sxbq972\",\"region\":\"cn-shanghai\"}

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

A731A84D-55C9-44F7-99BB-E1CF0CF19197
UserIdstring

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

276065346797410278
OwnerIdstring

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

1557702098194904
GmtCreateTimestring

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

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

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

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

数据集加速组件的唯一标识符。

cmpt-5zk866779me51jgu3w
Namestring

数据集加速组件名称。

dataset-accelerator
Versionstring

数据集加速组件版本。

v1.0.0
Templateobject

数据集加速组件模板信息。

Typestring

数据集加速组件模板的类型。 OSS:从 OSS 中读取模板 Helm 包。

OSS
Uristring

数据集加速组件模板的资源标识符,数据类型不同存在不同格式。

data/VOCdevkit/VOC2007/ImageSets/Main/val.txt
RenderedContentstring

渲染后的数据集加速组件部署文件。

---\n# Source: dataset-accelerator/templates/dataset-accelerator\napiVersion: data.datasetacc.io/v1\nkind: DataSetAccelerator\nmetadata:\n name: dataset-accelerator\nspec:\n frontEndAddr: 10.0.0.2\n frontEndPort: 7001\n

示例

正常返回示例

JSON格式

{
  "RequestId": "A731A84D-55C9-44F7-99BB-E1CF0CF19197",
  "UserId": "276065346797410278",
  "OwnerId": "1557702098194904",
  "GmtCreateTime": "2014-10-02T15:01:23Z",
  "GmtModifiedTime": "2014-10-02T15:01:23Z",
  "Uuid": "cmpt-5zk866779me51jgu3w",
  "Name": "dataset-accelerator",
  "Version": "v1.0.0",
  "Template": {
    "Type": "OSS",
    "Uri": "data/VOCdevkit/VOC2007/ImageSets/Main/val.txt"
  },
  "RenderedContent": "---\\n# Source: dataset-accelerator/templates/dataset-accelerator\\napiVersion: data.datasetacc.io/v1\\nkind: DataSetAccelerator\\nmetadata:\\n  name: dataset-accelerator\\nspec:\\n  frontEndAddr: 10.0.0.2\\n  frontEndPort: 7001\\n"
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈