Obtaining Template Metadata

Function

ShowTemplateMetadata

This API obtains the metadata of the current template.

To obtain details, you can refer to ShowTemplateMetadataResponseBody. To view all versions of a template, call ListTemplateVersions.

template_id is the unique ID of the template. It is a UUID generated by RFS when a template is created. Template names are unique at one specific time, so you can create a template named HelloWorld and another template with the same name after deleting the first one. For parallel development, team members may want to ensure that they are operating the template they created, not one with the same name created by other members after deleting the previous one. To avoid this mismatch, check the ID, since RFS ensures each template has a unique ID that does not change with updates. If the template_id value differs from the current template ID, 400 is returned.

URI

GET /v1/{project_id}/templates/{template_name}/metadata

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. It can be obtained by calling an API or from the console. Obtaining a Project ID
template_name	Yes	String	Name of the template to be created.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
template_id	No	String	ID of a template. If template_id exists, the template service checks whether template_id matches template_name. If not, 400 is returned.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
Client-Request-Id	Yes	String	Unique request ID. It is specified by a user and is used to locate a request. UUID is recommended.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
template_id	String	Unique template ID. It is randomly generated by the template service.
template_name	String	Name of the template to be created.
template_description	String	Template description. It can be used by users to identify their own templates.
create_time	String	Creation time of a template. The format complies with RFC 3339 (YYYY-MM-DDTHH:MM:SSZ), for example, 1970-01-01T00:00:00Z.
update_time	String	Update time of a template. The format complies with RFC 3339 (YYYY-MM-DDTHH:MM:SSZ), for example, 1970-01-01T00:00:00Z.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	The message contains information about unauthorized requests.
details	Array of Detail objects	Detailed error messages returned by service when permission is denied.

**Table 6** Detail
Parameter	Type	Description
error_code	String	Response code.
error_msg	String	Response message.

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	The message contains information about unauthorized requests.
details	Array of Detail objects	Detailed error messages returned by service when permission is denied.

**Table 8** Detail
Parameter	Type	Description
error_code	String	Response code.
error_msg	String	Response message.

Status code: 403

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	The message contains information about unauthorized requests.
details	Array of Detail objects	Detailed error messages returned by service when permission is denied.

**Table 10** Detail
Parameter	Type	Description
error_code	String	Response code.
error_msg	String	Response message.

Status code: 404

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	The message contains information about unauthorized requests.
details	Array of Detail objects	Detailed error messages returned by service when permission is denied.

**Table 12** Detail
Parameter	Type	Description
error_code	String	Response code.
error_msg	String	Response message.

Status code: 429

**Table 13** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	The message contains information about unauthorized requests.
details	Array of Detail objects	Detailed error messages returned by service when permission is denied.

**Table 14** Detail
Parameter	Type	Description
error_code	String	Response code.
error_msg	String	Response message.

Status code: 500

**Table 15** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	The message contains information about unauthorized requests.
details	Array of Detail objects	Detailed error messages returned by service when permission is denied.

**Table 16** Detail
Parameter	Type	Description
error_code	String	Response code.
error_msg	String	Response message.

Example Requests

Obtain the metadata of the current template.

GET https://{endpoint}/v1/c364070ab35041ddae68cf8b4839b60f/templates/my_template/metadata

Obtain the metadata of the current template and check whether the template ID matches the current template.

GET https://{endpoint}/v1/c364070ab35041ddae68cf8b4839b60f/templates/my_template/metadata?template_id=1b15e005-bdbb-4bd7-8f9a-a09b6774b4b3

Example Responses

Status code: 200

Template metadata obtained.

{
  "template_id" : "69f8d5ea-eaa4-4a3b-a96d-bae9230e97c8",
  "template_name" : "my_first_template",
  "template_description" : "Template description",
  "create_time" : "2023-05-09T08:00:00Z",
  "update_time" : "2023-05-09T09:00:00Z"
}

Status Codes

Status Code	Description
200	Template metadata obtained.
400	Invalid request.
401	Authentication failed.
403	The user does not have the permission to call this API.
404	The template does not exist.
429	Too frequent requests.
500	Internal server error.