Last updated: 2021-10-26 11:45:03

1. API Description

Domain name for API request:

This API is used to return the list of all layers, including the information of the latest version of each layer. You can filter them by the compatible runtime.

A maximum of 20 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 parameter. The value used for this API: ListLayers.
Version Yes String Common parameter. The value used for this API: 2018-04-16.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
CompatibleRuntime No String Compatible runtimes
Offset No Integer Offset
Limit No Integer Limit
SearchKey No String Query key, which fuzzily matches the name

3. Output Parameters

Parameter Name Type Description
Layers Array of LayerVersionInfo Layer list
TotalCount Integer Total number of layers
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Pulling layer list

Input Example

Content-Type: application/json
X-TC-Action: ListLayers
<Common request parameters>

    "SearchKey": "xx",
    "CompatibleRuntime": "xx",
    "Limit": 0,
    "Offset": 0

Output Example

  "Response": {
    "Layers": [
        "Status": "xx",
        "LayerVersion": 0,
        "Description": "xx",
        "LicenseInfo": "xx",
        "AddTime": "xx",
        "CompatibleRuntimes": [
        "LayerName": "xx"
    "TotalCount": 0,
    "RequestId": "xx"

5. Developer Resources


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.
InternalError.System Internal system error.
InvalidParameterValue.Runtime Runtime error.
InvalidParameterValue.Stamp The value of Stamp does not meet the specification. Please fix it and try again.
UnauthorizedOperation.CAM CAM authentication failed.