Edge Developer Platform
  • Image Renderer
    • Product Introduction
    • Getting Started
    • Development Guide
      • Overview
      • Signature URL
      • API Generation
    • Open API
      • Overview
      • API Documentation
      • API List
        • Account Verification
        • Get Template List
        • Get Template Instance
        • Get Image Signed URL
    • FAQs
Docs Overview/
Edge Developer Platform/
Image Renderer/
Open API/
API List/
Get Template Instance/

Get Template Instance

Interface description

Request Domain: image.edgeone.app.
Retrieve the template information under the user's account for the specified Template ID.
:
1. All interfaces require ApiKey + UserId for API authentication. The API Key is your private key. Please avoid leaking the API Key when invoking the API.
2. The RequestId in the response can be used for tracing and troubleshooting issues.

URL Path

/api/v1/DescribeTemplate

Request method

POST

Request headers

Content-Type: application/json

Request parameters

Parameter Name
Type
Required
Description
ApiKey
string
Yes
User's `ApiKey`
UserId
string
Yes
User ID
Id
string
Yes
Template ID

Response data type

JSON

Sample response

{
    "code": 0,
    "data": {
        "Response": {
            // ... Template Instance Details ...
        }
    },
    "message": "ok",
    "requestId": "01889e9f-xxxx-xxxx-xxxx-xxxx"
}

Field description

code (int): Response status code, 0 indicates success.
data (object): Object containing the actual response data.
Response (object): Actual business response data.
Id (string): Template ID.
Name (string): Template Name.
Description (string): Template Description.
Format (string): Template Format.
Size (string): Template Size.
TemplateVariables (string): Template Variables, JSON format string.
PreviewUrl (string): Template Preview URL.
CreatedTime (string): Creation time.
UpdatedTime (string): Update time.
AuditStatus (string): Audit status, 'normal' means normal, 'abnormal' means abnormal.
message (string): Response message.
requestId (string): Request ID.