History
Introduction
API Category
Making API Requests
Region APIs
Instance APIs
Cloud Hosting Cluster APIs
Image APIs
Instance Launch Template APIs
Placement Group APIs
Key APIs
Security Group APIs
Network APIs
Data Types
Error Codes
Domain name for API request: tem.intl.tencentcloudapi.com.
This API is used to obtain the basic information of an environment.
A maximum of 20 requests can be initiated per second for this API.
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: DescribeEnvironment. |
| 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. |
| EnvironmentId | Yes | String | Namespace ID |
| SourceChannel | No | Integer | Source channel |
| Parameter Name | Type | Description |
|---|---|---|
| Result | NamespaceInfo | Environment information |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to obtain the environment status.
POST / HTTP/1.1
Host: tem.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeEnvironment
<Common request parameters>
{
"EnvironmentId": "xx",
"SourceChannel": 0
}{
"Response": {
"Result": {
"EnvironmentId": "xx",
"VpcId": "xx",
"Locked": 0,
"Description": "xx",
"EnvironmentName": "xx",
"NamespaceName": "xx",
"Region": "xx",
"Tags": [
{
"TagKey": "xx",
"TagValue": "xx"
}
],
"ApmInstanceId": "xx",
"CreatedDate": "xx",
"SubnetIds": [
"subnet-xxx"
]
},
"RequestId": "xx"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InvalidParameterValue.NamespaceNotBelongToAppid | The namespace does not belong to the current account. |
| InvalidParameterValue.NamespaceNotFound | The environment does not exist. |
| InvalidParameterValue.TemIdInvalid | The TEM ID is incorrect. |
| MissingParameter.NamespaceIdNull | The environment ID can not be left empty. |
| ResourceNotFound.VersionNamespaceNotFound | The environment corresponding to this version is not found. |
| UnauthorizedOperation.UnauthorizedOperation | Not authorized |
Esta página foi útil?
Você também pode entrar em contato com a Equipe de vendas ou Enviar um tíquete em caso de ajuda.
comentários