Help Center/ Resource Governance Center/ API Reference/ APIs/ Managing Templates/ Querying Predefined Templates
Updated on 2026-01-13 GMT+08:00
View PDF
Share

Querying Predefined Templates

Function

This API is used to query a list of predefined templates.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

rgc:predefinedTemplate:list

List

-

-

-

-

URI

GET /v1/rgc/predefined-templates

Request Parameters

None

Response Parameters

Status code: 200

Table 1 Response body parameters

Parameter

Type

Description

templates

Array of PredefinedTemplate objects

Information about predefined templates.
Table 2 PredefinedTemplate

Parameter

Type

Description

template_name

String

Template name.

template_description

String

Template description.

template_category

String

Template type.

Status code: 403

Table 3 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

request_id

String

Unique ID of the request.

encoded_authorization_message

String

Encrypted error message.

details

Array of ForbiddenErrorDetail objects

Error message indicating no permissions for cross-service invoking.
Table 4 ForbiddenErrorDetail

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

Querying templates predefined in RGC

GET https://{endpoint}/v1/rgc/predefined-templates

Example Responses

Status code: 200

Request succeeded.

{
  "templates" : [ {
    "template_name" : "string",
    "template_description" : "string",
    "template_category" : "string"
  } ]
}

Status Codes

Status Code

Description

200

Request succeeded.

403

No permissions.

Error Codes

See Error Codes.

Parent topic: Managing Templates