查询PPT作品信息。
接口说明
接入说明:
- 当前接口为 HTTP-SSE 协议。
- 由于 OpenAPI 门户目前对 SSE 推理协议不兼容(无法直接调试),接口 SDK 方式调用示例(支持 Java、Python 版本的 sdk)请参考 PPT 生成最佳实践文档。
- 其中获取 Java 异步 SDK 的最新版本: 请点击链接获取。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
-
操作:是指具体的权限点。
-
访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
-
资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源表示。
-
条件关键字:是指云产品自身定义的条件关键字。
-
关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
aimiaobi:GetPptArtifact | get | *全部资源
| 无 | 无 |
请求语法
POST HTTP/1.1
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| WorkspaceId | string | 否 | 业务空间 ID | llm-az2gglxxxx |
| PptArtifactId | integer | 否 | PPT 作品 ID | 5232136 |
| ExternalUserId | string | 否 | abc |
返回参数
名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
object | Schema of Response | ||
| RequestId | string | Id of the request | xxxxx |
| Success | boolean | 此次请求是否成功 | true |
| Code | string | 错误码 | DataNotExists |
| Message | string | 错误消息 | 错误消息 |
| HttpStatusCode | integer | http 错误码 | 400 |
| Data | object | 任务响应对象 | |
| CreateTime | string | 更新日期 | 2024-11-25 11:40:50 |
| Id | integer | 文档唯一标识 | 10 |
| Title | string | 标题 | 内容标题 |
| UpdateTime | string | 更新日期 | 2024-11-25 11:40:50 |
| FileKey | string | 后端业务存储本次规则库解析结果的路径。 | oss://default/oss-bucket-name/aimiaobi/2021/07/01/1625126400000/1.docx |
| FileAttr | object | 文件属性 | |
| FileName | string | 文件名称 | xxx.pptx |
| Width | integer | 宽度 | 800 |
| TmpUrl | string | 视频文件临时访问 URL。1 小时过期 | |
| Height | integer | 高度 | 600 |
示例
正常返回示例
JSON格式
{
"RequestId": "xxxxx",
"Success": true,
"Code": "DataNotExists",
"Message": "错误消息",
"HttpStatusCode": 400,
"Data": {
"CreateTime": "2024-11-25 11:40:50",
"Id": 10,
"Title": "内容标题\n\n",
"UpdateTime": "2024-11-25 11:40:50",
"FileKey": "oss://default/oss-bucket-name/aimiaobi/2021/07/01/1625126400000/1.docx",
"FileAttr": {
"FileName": "xxx.pptx",
"Width": 800,
"TmpUrl": "http://www.example.com/xxx.pptx",
"Height": 600
}
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。