Updated on 2025-08-13 GMT+08:00

Querying the List of Task Creation Templates

Function

This API is used to query the batch creation template list.

URI

GET /v5/{project_id}/templates

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region.

For details about how to obtain the project ID, see Obtaining a Project ID.

Table 2 Query parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Offset. The records after this offset will be queried.

limit

No

Integer

Maximum number of records that can be returned.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

MIME type of the request body. The default value application/json is recommended. For APIs used to upload objects or images, the value varies depending on the flow type.

X-Auth-Token

Yes

String

User token obtained from IAM.

It is a response to the API for obtaining a user token. This API is the only one that does not require authentication.

After a response is returned, the value of X-Subject-Token in the response header is the token value.

X-Language

No

String

Request language type.

Enumerated values:

  • en-us

  • zh-cn

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

count

Integer

Total number.

export_report_obs_files

Array of export_report_obs_files objects

File list.

Table 5 export_report_obs_files

Parameter

Type

Description

file_name

String

File name.

last_modified

String

Last modification time.

Example Request

Querying the list of task creation templates

https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/templates?offset=0&limit=10

Example Response

Status code: 200

OK

{
  "count" : 1,
  "export_report_obs_files" : [ {
    "file_name" : "2e69ebb1-f06d-4eb2-a789-2883629jb204_postgresql_20250703094510.xlsx",
    "last_modified" : "2025-07-03T09:44:12Z"
  } ]
}

Status Code

Status Code

Description

200

OK

Error Code

For details, see Error Code.