tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeTemplateList

Last updated: 2024-09-25 10:27:43

1. API Description

Domain name for API request: cfg.tencentcloudapi.com.

This API is used to query the template list.

A maximum of 100 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeTemplateList.
Version Yes String Common Params. The value used for this API: 2021-08-20.
Region No String Common Params. This parameter is not required.
Limit Yes Integer Pagination limit.Maximum value:100.
Offset Yes Integer Pagination offset
Title No String Experiment name
Tag.N No Array of String Tag key
IsUsed No Integer Status. 1: in use; 2: not in use.
Tags.N No Array of TagWithDescribe Tag pair
TemplateSource No Integer Template library source. 0: self-built; 1: recommended by experts.
TemplateIdList.N No Array of Integer Template ID
Filters.N No Array of ActionFilter Filter parameters

3. Output Parameters

Parameter Name Type Description
TemplateList Array of TemplateListItem Template library list
Total Integer Number of template libraries in the list
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Template List

This example shows you how to query the template list.

Input Example

POST / HTTP/1.1
Host: cfg.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTemplateList
<Common request parameters>



{
    "Limit": "10",
    "Offset": "0"
}

Output Example

{
    "Response": {
        "RequestId": "0c06dc9d-1e90-4062-a038-74abf2bbd43d",
        "TemplateList": [
            {
                "TemplateId": 511,
                "TemplateTitle": "Testing template",
                "TemplateDescription": "Test",
                "TemplateTag": null,
                "TemplateIsUsed": 1,
                "TemplateCreateTime": "2021-10-12 17:28:13",
                "TemplateUpdateTime": "2021-10-12 17:48:16",
                "TemplateUsedNum": 0
            },
            {
                "TemplateId": 509,
                "TemplateTitle": "test",
                "TemplateDescription": "test",
                "TemplateTag": "test",
                "TemplateIsUsed": 2,
                "TemplateCreateTime": "2021-09-28 15:38:00",
                "TemplateUpdateTime": "2021-10-11 16:26:45",
                "TemplateUsedNum": 0
            }
        ],
        "Total": 2
    }
}

Example2 Querying the Template List

This example shows you how to query the template list.

Input Example

POST / HTTP/1.1
Host: cfg.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTemplateList
<Common request parameters>



{
    "Limit": 10,
    "Offset": 1
}

Output Example

{
    "Response": {
        "RequestId": "6775138e-92c5-40cb-ab0e-a61a5c63b5fa",
        "TemplateList": [
            {
                "TemplateCreateTime": "2023-06-06 15:05:18",
                "TemplateDescription": "3",
                "TemplateId": 914,
                "TemplateIsUsed": 1,
                "TemplateSource": 0,
                "TemplateTag": "",
                "TemplateTitle": "3",
                "TemplateUpdateTime": "2023-06-06 15:05:18",
                "TemplateUsedNum": 0
            },
            {
                "TemplateCreateTime": "2023-06-05 14:43:42",
                "TemplateDescription": "Simulate single-AZ faults at the access layer, logic layer, and data layer to verify the effectiveness of cross-AZ disaster recovery of the architecture.",
                "TemplateId": 913,
                "TemplateIsUsed": 1,
                "TemplateSource": 1,
                "TemplateTag": "",
                "TemplateTitle": "Cross-AZ disaster recovery experiment",
                "TemplateUpdateTime": "2023-06-05 14:43:42",
                "TemplateUsedNum": 0
            },
            {
                "TemplateCreateTime": "2023-06-05 14:42:31",
                "TemplateDescription": "Simulate single-AZ faults at the access layer, logic layer, and data layer to verify the effectiveness of cross-AZ disaster recovery of the architecture.",
                "TemplateId": 912,
                "TemplateIsUsed": 1,
                "TemplateSource": 1,
                "TemplateTag": "",
                "TemplateTitle": "Cross-AZ disaster recovery experiment",
                "TemplateUpdateTime": "2023-06-05 14:42:31",
                "TemplateUsedNum": 0
            },
            {
                "TemplateCreateTime": "2023-06-05 11:48:02",
                "TemplateDescription": "Simulate single-AZ faults at the access layer, logic layer, and data layer to verify the effectiveness of cross-AZ disaster recovery of the architecture.",
                "TemplateId": 910,
                "TemplateIsUsed": 1,
                "TemplateSource": 1,
                "TemplateTag": "",
                "TemplateTitle": "Cross-AZ disaster recovery experiment",
                "TemplateUpdateTime": "2023-06-05 11:48:02",
                "TemplateUsedNum": 0
            },
            {
                "TemplateCreateTime": "2023-06-05 11:48:02",
                "TemplateDescription": "Simulate single-AZ faults at the access layer, logic layer, and data layer to verify the effectiveness of cross-AZ disaster recovery of the architecture.",
                "TemplateId": 911,
                "TemplateIsUsed": 1,
                "TemplateSource": 1,
                "TemplateTag": "",
                "TemplateTitle": "Cross-AZ disaster recovery experiment",
                "TemplateUpdateTime": "2023-06-05 11:48:02",
                "TemplateUsedNum": 0
            },
            {
                "TemplateCreateTime": "2023-06-02 17:38:34",
                "TemplateDescription": "Simulate single-AZ faults at the access layer, logic layer, and data layer to verify the effectiveness of cross-AZ disaster recovery of the architecture.",
                "TemplateId": 904,
                "TemplateIsUsed": 1,
                "TemplateSource": 1,
                "TemplateTag": "",
                "TemplateTitle": "Cross-AZ disaster recovery experiment",
                "TemplateUpdateTime": "2023-06-02 17:38:34",
                "TemplateUsedNum": 0
            },
            {
                "TemplateCreateTime": "2023-06-02 17:38:34",
                "TemplateDescription": "Simulate single-AZ faults at the access layer, logic layer, and data layer to verify the effectiveness of cross-AZ disaster recovery of the architecture.",
                "TemplateId": 905,
                "TemplateIsUsed": 1,
                "TemplateSource": 1,
                "TemplateTag": "",
                "TemplateTitle": "Cross-AZ disaster recovery experiment",
                "TemplateUpdateTime": "2023-06-02 17:38:34",
                "TemplateUsedNum": 0
            },
            {
                "TemplateCreateTime": "2023-06-02 17:38:34",
                "TemplateDescription": "Simulate single-AZ faults at the access layer, logic layer, and data layer to verify the effectiveness of cross-AZ disaster recovery of the architecture.",
                "TemplateId": 906,
                "TemplateIsUsed": 1,
                "TemplateSource": 1,
                "TemplateTag": "",
                "TemplateTitle": "Cross-AZ disaster recovery experiment",
                "TemplateUpdateTime": "2023-06-02 17:38:34",
                "TemplateUsedNum": 0
            },
            {
                "TemplateCreateTime": "2023-06-02 17:38:34",
                "TemplateDescription": "Simulate single-AZ faults at the access layer, logic layer, and data layer to verify the effectiveness of cross-AZ disaster recovery of the architecture.",
                "TemplateId": 907,
                "TemplateIsUsed": 1,
                "TemplateSource": 1,
                "TemplateTag": "",
                "TemplateTitle": "Cross-AZ disaster recovery experiment",
                "TemplateUpdateTime": "2023-06-02 17:38:34",
                "TemplateUsedNum": 0
            },
            {
                "TemplateCreateTime": "2023-06-02 17:38:34",
                "TemplateDescription": "Simulate single-AZ faults at the access layer, logic layer, and data layer to verify the effectiveness of cross-AZ disaster recovery of the architecture.",
                "TemplateId": 908,
                "TemplateIsUsed": 2,
                "TemplateSource": 1,
                "TemplateTag": "",
                "TemplateTitle": "Cross-AZ disaster recovery experiment",
                "TemplateUpdateTime": "2023-06-13 16:30:37",
                "TemplateUsedNum": 0
            }
        ],
        "Total": 43
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InternalError Internal error.
InvalidParameter Parameter error.
InvalidParameterValue Parameter value error.
MissingParameter Parameters are missing
UnknownParameter Unknown parameter.
UnsupportedOperation The operation is not supported.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy