云托管 CloudBase Run 查询云托管服务列表

1. 接口描述

接口请求域名： tcbr.tencentcloudapi.com 。

查询云托管服务列表接口

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeCloudRunServers。
Version	是	String	公共参数，本接口取值：2022-02-17。
Region	否	String	公共参数，本接口不需要传递此参数。
EnvId	是	String	环境Id 示例值：env-example
PageSize	否	Integer	默认为9，最大为30 不传或传0时取默认9 大于30时取30 示例值：15
PageNum	否	Integer	不传或传0时会默认为1 示例值：1
ServerName	否	String	服务名示例值：server-name
ServerType	否	String	服务类型：function \| container 示例值：function

3. 输出参数

参数名称	类型	描述
ServerList	Array of ServerBaseInfo	服务列表
Total	Integer	服务总数示例值：10
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 success

输入示例

POST / HTTP/1.1
Host: tcbr.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCloudRunServers
<公共请求参数>

{
    "EnvId": "prod-2g59lad002c864a6"
}

输出示例

{
    "Response": {
        "RequestId": "8d28b0d2-8215-4f80-a6d2-3e1a372ac748",
        "ServerList": [
            {
                "AccessTypes": [
                    "OA",
                    "PUBLIC",
                    "MINIAPP"
                ],
                "CustomDomainName": "",
                "CustomDomainNames": [
                    ""
                ],
                "DefaultDomainName": "",
                "ServerName": "golang-h7yv",
                "Status": "running",
                "UpdateTime": "2024-09-13 10:31:56"
            }
        ],
        "Total": 1
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
ResourceNotFound	资源不存在。

查询云托管服务列表

本页目录：