云托管 CloudBase Run 查询云托管服务详情

1. 接口描述

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

查询云托管服务详情

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeCloudRunServerDetail。
Version	是	String	公共参数，本接口取值：2022-02-17。
Region	否	String	公共参数，本接口不需要传递此参数。
EnvId	是	String	环境Id 示例值：env-example
ServerName	是	String	服务名示例值：serverName

3. 输出参数

参数名称	类型	描述
BaseInfo	ServerBaseInfo	服务基本信息
ServerConfig	ServerBaseConfig	服务配置信息
OnlineVersionInfos	Array of OnlineVersionInfo	在线版本信息
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 DescribeCloudRunServerDetail

输入示例

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

{
    "EnvId": "prod-2g59lad002c864a6",
    "ServerName": "golang-h7yv"
}

输出示例

{
    "Response": {
        "BaseInfo": {
            "AccessTypes": [],
            "CustomDomainName": "",
            "CustomDomainNames": [],
            "DefaultDomainName": "https://golang-h7yv-121864-6-1258467748.sh.run.tcloudbase.com",
            "ServerName": "golang-h7yv",
            "Status": "running",
            "UpdateTime": "2024-09-13 10:31:56"
        },
        "OnlineVersionInfos": [
            {
                "FlowRatio": "100",
                "ImageUrl": "ccr.ccs.tencentyun.com/weixincloud/weixincloud_golang:10",
                "VersionName": "golang-h7yv-001"
            }
        ],
        "RequestId": "ec98425e-cc3f-4c95-a231-cd144757c9bd",
        "ServerConfig": {
            "BuildDir": "",
            "Cpu": 1,
            "CreateTime": "2024-09-13 10:31:17",
            "CustomLogs": "stdout",
            "Dockerfile": "Dockerfile",
            "EnvId": "prod-2g59lad002c864a6",
            "EnvParams": "",
            "HasDockerfile": false,
            "InitialDelaySeconds": 2,
            "LogParseType": "",
            "LogSetId": "",
            "LogTopicId": "",
            "LogType": "",
            "MaxNum": 5,
            "Mem": 2,
            "MinNum": 0,
            "OpenAccessTypes": [],
            "PolicyDetails": [
                {
                    "PolicyThreshold": 60,
                    "PolicyType": "cpu"
                },
                {
                    "PolicyThreshold": 60,
                    "PolicyType": "mem"
                }
            ],
            "Port": 8080,
            "ServerName": "golang-h7yv",
            "Tag": ""
        }
    }
}

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	资源不存在。