- 动态与公告
- 产品简介
- 购买指南
- 快速入门
- 操作指南
- 实践教程
- API 文档
- 常见问题
- 联系我们
- 词汇表
- 动态与公告
- 产品简介
- 购买指南
- 快速入门
- 操作指南
- 实践教程
- API 文档
- 常见问题
- 联系我们
- 词汇表
1. API Description
Domain name for API request: tem.tencentcloudapi.com.
This API is used to check the basic information of an application.
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 Params. The value used for this API: DescribeApplicationInfo. |
| Version | Yes | String | Common Params. The value used for this API: 2021-07-01. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| ApplicationId | Yes | String | Application ID |
| SourceChannel | No | Integer | Source channel. Please keep the default value. |
| EnvironmentId | No | String | Environment ID |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| Result | TemServiceVersionInfo | Returned result. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Example
Example1 Checking the basic information of an application
This example shows you how to check the basic information of an application.
Input Example
POST / HTTP/1.1
Host: tem.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeApplicationInfo
<Common request parameters>
{
"SourceChannel": 0,
"ApplicationId": "xx",
"EnvironmentId": "xx"
}
Output Example
{
"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. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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 |
|---|---|
| FailedOperation.ActionReadTimeout | Request timed out |
| FailedOperation.DefaultInternalError | The server is busy. Retry later. |
| FailedOperation.DescribeRunPodListError | Failed to query the instance information |
| FailedOperation.DescribeServiceError | Failed to query the service. |
| InternalError.ActionReadTimeout | Request timed out |
| InternalError.DefaultInternalError | The server is busy. Retry later. |
| InternalError.DescribeRunPodListError | Failed to query the instance information |
| InternalError.DescribeServiceError | Failed to query the service. |
| InvalidParameterValue.ServiceNotBelongToAppid | You are not the owner of this application. |
| InvalidParameterValue.TemIdInvalid | The TEM ID is incorrect. |
| MissingParameter.ServiceIdNull | The service ID cannot be empty. |
| ResourceNotFound.MicroserviceOffline | The target microservice is offline. |
| ResourceNotFound.ServiceNotFound | The application is not found. |
| ResourceNotFound.ServiceRunningVersionNotFound | No running pod is found. |
| ResourceNotFound.VersionNamespaceNotFound | The environment corresponding to this version is not found. |
| ResourceNotFound.VersionServiceNotFound | The environment corresponding to this version is not found. |
| UnauthorizedOperation.UnauthorizedOperation | Not authorized |
是
否
本页内容是否解决了您的问题？