CreateDataAgentTheme - 创建DataAgent主题

更新时间:
复制 MD 格式

CreateDataAgentTheme

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

dms:CreateDataAgentTheme

create

*全部资源

*

无 无

请求语法

POST  HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

ThemeId

string

否

主题 UUID,需要是 GetDataAgentThemeUploadSignature 返回,且文件已直传完成。若伪造 UUID 或者文件未上传,则创建会失败。

0f8b2c1d************9a3e5f7b1c2d

ThemeName

string

否

主题展示名,最长 64 字符,创建时必须填入

weekly report

FileFrom

string

否

文件来源,影响后端判断主题是否合法的逻辑,当前包含如下枚举:

  • upload,表示通过 OSS 上传

  • (暂不支持)public_url,表示通过可公网访问的 OSS 链接提供

  • (暂不支持)user_oss,表示通过用户 OSS 链接提供

upload

ThemeType

string

否

自定义主题的类型,包含如下枚举:

  • (默认)template,表示是模板

  • (暂不支持)design,表示是 DESIGN.md

template

Category

string

否

应用场景,影响控制台查看主题列表时的过滤。当前包含如下枚举:

  • (建议)custom,表示是用户上传的自定义主题,不预设风格和信息组织结构

  • report,表示是符合 DataAgent 信息组织结构的网页报告

  • (暂不支持)infographic,表示是符合 DataAgent 信息组织结构的信息图

custom

Description

string

否

描述,最长 255 字符

weekly report

WorkspaceId

string

否

所属工作空间:缺省或 personal → 个人空间;显式传协作空间 ID

99fad******qg6c0l4nlacu

返回参数

名称

类型

描述

示例值

object

Schema of Response

Data

object

返回结构体

FilePath

string

主题文件 OSS key(dart/{uid}/{theme_id}/theme.zip,落库前已校验存在)

dart/174****/0f8b****/theme.zip

ThemeId

string

主题业务标识

0f8b2c1d************9a3e5f7b1c2d

ErrorCode

string

错误码,请求异常时返回。

UnknownError

ErrorMessage

string

调用失败时,返回的错误信息。

UnknownError

RequestId

string

请求 ID,用于定位日志,排查问题。

67E910F2-4B62-5B0C-ACA3-7547695C****

Success

boolean

请求是否成功,返回值如下:

  • true:请求成功。

  • false:请求失败。

示例

正常返回示例

JSON格式

{
  "Data": {
    "FilePath": "dart/174****/0f8b****/theme.zip",
    "ThemeId": "0f8b2c1d************9a3e5f7b1c2d"
  },
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "RequestId": "67E910F2-4B62-5B0C-ACA3-7547695C****",
  "Success": true
}

错误码

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

变更历史

更多信息,参考变更详情。