DescribeDataAgentTheme - 查询 DataAgent 主题详情

更新时间:
复制 MD 格式

调用 DescribeDataAgentTheme 接口查询单个 DataAgent 主题的详细信息,包括主题名称、阶段、来源、应用场景、描述和创建修改时间等。

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

dms:DescribeDataAgentTheme

get

*全部资源

*

无 无

请求语法

POST  HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

ThemeId

string

否

主题业务标识

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

返回参数

名称

类型

描述

示例值

object

Schema of Response

Data

object

返回结构体

Category

string

应用场景:report / infographic / ...

custom

CreatedAt

string

创建时间(ISO 8601)

2025-06-15T08:30:00Z

Description

string

主题描述

weekly report

ModifiedAt

string

修改时间(ISO 8601)

2025-06-20T10:15:30Z

ReferTo

string

主题溯源信息,当前未启用

6d1e3f9a-****-****-****-2b8c4e6f0a1d

ThemeFrom

string

来源:system / custom

custom

ThemeId

string

主题业务标识

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

ThemeName

string

主题展示名

weekly report

ThemeType

string

主题阶段:design(仅 design.md)/ template(完整,可渲染)

template

ErrorCode

string

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

UnknownError

ErrorMessage

string

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

UnknownError

RequestId

string

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

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

Success

boolean

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

  • true:请求成功。

  • false:请求失败。

示例

正常返回示例

JSON格式

{
  "Data": {
    "Category": "custom",
    "CreatedAt": "2025-06-15T08:30:00Z",
    "Description": "weekly report",
    "ModifiedAt": "2025-06-20T10:15:30Z",
    "ReferTo": "6d1e3f9a-****-****-****-2b8c4e6f0a1d",
    "ThemeFrom": "custom",
    "ThemeId": "0f8b2c1d***********9a3e5f7b1c2d",
    "ThemeName": "weekly report",
    "ThemeType": "template"
  },
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "RequestId": "67E910F2-4B62-5B0C-ACA3-7547695C****",
  "Success": true
}

错误码

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

变更历史

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