1. 接口描述
接口请求域名: tem.tencentcloudapi.com 。
获取分批发布详情
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeDeployApplicationDetail。 |
Version | 是 | String | 公共参数,本接口取值:2021-07-01。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ApplicationId | 否 | String | 服务id 示例值:service-123 |
EnvironmentId | 否 | String | 环境id 示例值:env-123 |
VersionId | 否 | String | 版本部署id 示例值:version-123 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Result | TemDeployApplicationDetailInfo | 分批发布结果详情 示例值:{} |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取分批发布详情
获取分批发布详情
输入示例
POST / HTTP/1.1
Host: tem.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDeployApplicationDetail
<公共请求参数>
{
"EnvironmentId": "xx",
"ApplicationId": "xx"
}
输出示例
{
"Response": {
"Result": {
"Status": "xx",
"NewVersionPackageInfo": "xx",
"NextBatchStartTime": 0,
"OldDeployVersion": "xx",
"BetaBatchDetail": {
"NewPods": [
{
"Webshell": "xx",
"PodStatus": [
"xx"
],
"Zone": "xx",
"PodId": "xx",
"CreateTime": "xx",
"PodVersion": "xx"
}
],
"NewPodList": {
"Webshell": "xx",
"PodStatus": [
"xx"
],
"Zone": "xx",
"PodId": "xx",
"CreateTime": "xx",
"PodVersion": "xx"
},
"BatchIndex": 0,
"OldPodList": {
"Webshell": "xx",
"PodStatus": [
"xx"
],
"Zone": "xx",
"PodId": "xx",
"CreateTime": "xx",
"PodVersion": "xx"
},
"NextBatchStartTime": 0,
"OldPods": [
{
"Webshell": "xx",
"PodStatus": [
"xx"
],
"Zone": "xx",
"PodId": "xx",
"CreateTime": "xx",
"PodVersion": "xx"
}
],
"BatchStatus": "xx",
"PodNum": 0
},
"ErrorMessage": "xx",
"DeployStrategyConf": {
"TotalBatchCount": 0,
"DeployStrategyType": 0,
"BatchInterval": 0,
"BetaBatchNum": 0
},
"NewDeployVersion": "xx",
"StartTime": "xx",
"OtherBatchDetail": [
{
"NewPods": [
{
"Webshell": "xx",
"PodStatus": [
"xx"
],
"Zone": "xx",
"PodId": "xx",
"CreateTime": "xx",
"PodVersion": "xx"
}
],
"NewPodList": {
"Webshell": "xx",
"PodStatus": [
"xx"
],
"Zone": "xx",
"PodId": "xx",
"CreateTime": "xx",
"PodVersion": "xx"
},
"BatchIndex": 0,
"OldPodList": {
"Webshell": "xx",
"PodStatus": [
"xx"
],
"Zone": "xx",
"PodId": "xx",
"CreateTime": "xx",
"PodVersion": "xx"
},
"NextBatchStartTime": 0,
"OldPods": [
{
"Webshell": "xx",
"PodStatus": [
"xx"
],
"Zone": "xx",
"PodId": "xx",
"CreateTime": "xx",
"PodVersion": "xx"
}
],
"BatchStatus": "xx",
"PodNum": 0
}
],
"CurrentBatchIndex": 0,
"EndTime": "xx",
"CurrentBatchStatus": "xx",
"OldVersionPodList": {
"TotalCount": 0,
"Limit": 0,
"RequestId": "xx",
"PodList": [
{
"Webshell": "xx",
"Status": "xx",
"RestartCount": 0,
"Zone": "xx",
"PodId": "xx",
"DeployVersion": "xx",
"PodIp": "xx",
"ContainerState": "xx",
"Ready": true,
"CreateTime": "xx"
}
],
"Offset": 0
}
},
"RequestId": "xx"
}
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.DescribeRunPodListError | 查询实例信息失败。 |
InternalError.DefaultInternalError | 服务器繁忙,请稍后再试。 |
InternalError.DescribeRunPodListError | 查询实例信息失败。 |
InvalidParameterValue.NamespaceNotBelongToAppid | 命名空间不属于用户。 |
InvalidParameterValue.TemIdInvalid | 不是合法的TEM ID。 |
MissingParameter.NamespaceIdNull | 环境ID不能为空。 |
ResourceNotFound.MicroserviceOffline | 目标微服务已离线。 |
ResourceNotFound.ServiceNotFound | 找不到应用。 |
ResourceNotFound.VersionNamespaceNotFound | 找不到版本对应的环境。 |
ResourceNotFound.VersionServiceNotFound | 找不到版本对应的应用。 |
UnauthorizedOperation.UnauthorizedOperation | 未授权。 |