获取模板实例
接口描述
接口请求域名:image.edgeone.site。
获取用户账户下指定模板 Id 的模板信息。
:
1. 所有接口都需要传 ApiKey + UserId 用于接口鉴权,API Key为您的私有密钥,请在调用 API 时避免泄露 API Key。
2. 响应中的 RequestId 可用于追踪和排查问题。
接口地址
/api/v1/DescribeTemplate
请求方法
POST
请求头
Content-Type: application/json
请求参数
参数名 | 类型 | 必填 | 描述 |
ApiKey | string | 是 | 用户 ApiKey |
UserId | string | 是 | 用户 ID |
Id | string | 是 | 模板 ID |
响应数据类型
JSON
响应示例
{"code": 0,"data": {"Response": {// ... 模板实例详情 ...}},"message": "ok","requestId": "01889e9f-xxxx-xxxx-xxxx-xxxx"}
字段说明
code
(int): 响应状态码,0 表示成功。data
(object): 包含实际响应数据的对象。Response
(object): 实际的业务响应数据。Id
(string): 模板 ID。Name
(string): 模板名称。Description
(string): 模板描述。Format
(string): 模板格式。Size
(string): 模板尺寸。TemplateVariables
(string): 模板变量,JSON 格式字符串。PreviewUrl
(string): 模板预览 URL。CreatedTime
(string): 创建时间。UpdatedTime
(string): 更新时间。AuditStatus
(string): 审核状态, normal 表示正常,abnormal 表示不正常。message
(string): 响应消息。requestId
(string): 请求 ID。