1. 接口描述
接口请求域名: tem.tencentcloudapi.com 。
服务基本信息查看
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeApplicationInfo。 |
Version | 是 | String | 公共参数,本接口取值:2021-07-01。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ApplicationId | 是 | String | 服务版本ID 示例值:1 |
SourceChannel | 否 | Integer | 来源渠道 示例值:0 |
EnvironmentId | 否 | String | 环境ID 示例值:1 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Result | TemServiceVersionInfo | 返回结果 示例值:1 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 服务基本信息查看
服务基本信息查看
输入示例
POST / HTTP/1.1
Host: tem.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeApplicationInfo
<公共请求参数>
{
"SourceChannel": 0,
"ApplicationId": "xx",
"EnvironmentId": "xx"
}
输出示例
{
"Response": {
"Result": {
"CurrentInstances": 1,
"ImgName": "xx",
"Service": {
"ApplicationName": "xx",
"ExternalIp": "xx",
"Name": "xx",
"ApplicationId": "xx",
"AllIpDone": true,
"PortMappings": [
{
"Protocol": "xx",
"ServiceName": "xx",
"TargetPort": 0,
"Port": 0
}
],
"Yaml": "xx",
"LoadBalanceId": "xx",
"ServicePortMappingList": [
{
"ExternalIp": "xx",
"VpcId": "xx",
"PortMappingItemList": [
{
"Protocol": "xx",
"TargetPort": 0,
"Port": 0
}
],
"Yaml": "xx",
"LoadBalanceId": "xx",
"ServiceName": "xx",
"ClusterIp": "xx",
"SubnetId": "xx",
"Type": "xx",
"Ports": [
0
]
}
],
"VersionName": "xx",
"ClusterIp": [
"xx"
],
"SubnetId": "xx",
"Type": "xx",
"Ports": [
0
],
"EnableRegistryNextDeploy": 0,
"FlushAll": true
},
"JvmOpts": "xx",
"SpeedUp": true,
"ImageTag": "xx",
"PublicDomain": "xx",
"StorageConfs": [
{
"StorageVolName": "xx",
"StorageVolIp": "xx",
"StorageVolPath": "xx"
}
],
"EnableTracingReport": 1,
"ExpectedInstances": 1,
"ImgRepo": "xx",
"StartupProbe": {
"Protocol": "xx",
"TimeoutSeconds": 0,
"Exec": "xx",
"InitialDelaySeconds": 0,
"PeriodSeconds": 0,
"Path": "xx",
"Type": "xx",
"Port": 0
},
"OsFlavour": "xx",
"BatchDeployStatus": "xx",
"Status": "xx",
"EnvironmentName": "xx",
"ImageCommand": "xx",
"ModifyDate": "xx",
"Description": "xx",
"EnablePublicAccess": true,
"StoppedManually": true,
"EnvConf": [
{
"Config": "xx",
"Secret": "xx",
"Type": "xx",
"Value": "xx",
"Key": "xx"
}
],
"LastDeploySuccessDate": "xx",
"JdkVersion": "xx",
"ApmInstanceId": "xx",
"Vpc": "xx",
"EnablePrometheusConf": {
"Path": "xx",
"Port": 0
},
"EnableTracing": 1,
"CodingLanguage": "xx",
"SubnetId": "xx",
"ApplicationId": "xx",
"ApplicationName": "xx",
"Readiness": {
"Protocol": "xx",
"TimeoutSeconds": 0,
"Exec": "xx",
"InitialDelaySeconds": 0,
"PeriodSeconds": 0,
"Path": "xx",
"Type": "xx",
"Port": 0
},
"LogOutputConf": {
"ClsLogTopicId": "xx",
"ClsLogsetName": "xx",
"ClsLogsetId": "xx",
"ClsLogTopicName": "xx",
"OutputType": "xx"
},
"UseRegistryDefaultConfig": true,
"ApplicationDescription": "xx",
"PublishMode": "xx",
"CpuSpec": 0.0,
"EsEnable": 0,
"CreateDate": "xx",
"Liveness": {
"Protocol": "xx",
"TimeoutSeconds": 0,
"Exec": "xx",
"InitialDelaySeconds": 0,
"PeriodSeconds": 0,
"Path": "xx",
"Type": "xx",
"Port": 0
},
"EnableMetrics": 0,
"DeployMode": "xx",
"SecurityGroupIds": [
"xx"
],
"TcrInstanceId": "xx",
"CronHorizontalAutoscaler": [
{
"Priority": 0,
"Schedules": [
{
"StartAt": "xx",
"TargetReplicas": 0
}
],
"Enabled": true,
"Period": "xx",
"Name": "xx"
}
],
"DeployVersion": "xx",
"InitPodNum": 0,
"RepoType": 1,
"ImageArgs": [
"xx"
],
"MemorySpec": 0.0,
"WorkloadInfo": {
"ApplicationName": "xx",
"ClusterId": "xx"
},
"ImageType": 0,
"PreStop": "xx",
"EnvironmentId": "xx",
"LogConfs": [
"xx"
],
"PkgName": "xx",
"StorageMountConfs": [
{
"VolumeName": "xx",
"MountPath": "xx"
}
],
"HorizontalAutoscaler": [
{
"MinReplicas": 0,
"Metrics": "xx",
"Enabled": true,
"Threshold": 0,
"MaxReplicas": 0
}
],
"UnderDeploying": true,
"LogEnable": 0,
"EsInfo": {
"MinAliveInstances": 0,
"EsStrategy": 0,
"VersionId": "xx",
"Threshold": 1,
"MaxAliveInstances": 0
},
"Zones": [
"xx"
],
"ImgVersion": "xx",
"VersionId": "xx",
"LastDeployDate": "xx",
"SettingConfs": [
{
"ConfigDataName": "xx",
"MountedPath": "xx",
"SecretDataName": "xx",
"Data": [
{
"Config": "xx",
"Secret": "xx",
"Type": "xx",
"Value": "xx",
"Key": "xx"
}
]
}
],
"VersionName": "xx",
"MinAliveInstances": "xx",
"EsStrategy": 0,
"NodeInfos": [
{
"SubnetId": "xx",
"Cidr": "xx",
"AvailableIpCount": "xx",
"Name": "xx",
"Zone": "xx"
}
],
"RepoServer": "xx",
"PostStart": "xx"
},
"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.ActionReadTimeout | 请求响应超时。 |
FailedOperation.DefaultInternalError | 服务器繁忙,请稍后再试。 |
FailedOperation.DescribeRunPodListError | 查询实例信息失败。 |
FailedOperation.DescribeServiceError | 查询service失败。 |
InternalError.ActionReadTimeout | 请求响应超时。 |
InternalError.DefaultInternalError | 服务器繁忙,请稍后再试。 |
InternalError.DescribeRunPodListError | 查询实例信息失败。 |
InternalError.DescribeServiceError | 查询service失败。 |
InvalidParameterValue.ServiceNotBelongToAppid | 应用不属于此账户。 |
InvalidParameterValue.TemIdInvalid | 不是合法的TEM ID。 |
MissingParameter.ServiceIdNull | 服务ID不能为空。 |
ResourceNotFound.MicroserviceOffline | 目标微服务已离线。 |
ResourceNotFound.ServiceNotFound | 找不到应用。 |
ResourceNotFound.ServiceRunningVersionNotFound | 找不到运行的服务实例。 |
ResourceNotFound.VersionNamespaceNotFound | 找不到版本对应的环境。 |
ResourceNotFound.VersionServiceNotFound | 找不到版本对应的应用。 |
UnauthorizedOperation.UnauthorizedOperation | 未授权。 |