1. 接口描述
接口请求域名: tcb.tencentcloudapi.com 。
获取环境下单地域
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeEnvDealRegion。 |
Version | 是 | String | 公共参数,本接口取值:2018-06-08。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
EnvId | 是 | String | 环境ID 示例值:test-12323 |
DealType | 是 | String | 订单类型: ENV_PREPAY_MINIAPP= 预付费环境(微信小程序) ENV_PREPAY_CLOUD= 预付费环境(腾讯云) ENV_POSTPAY = 后付费环境 HOSTING_PREPAY = 预付费静态托管 PACKAGE=套餐包 示例值:ENV_PREPAY |
DealAction | 是 | String | 下单类型: CREATE = 新购 RENEW = 续费 MODIFY = 套餐调整(升级/降级) REFUND = 退费 示例值:RENEW |
DealRegion | 是 | String | 下单地域: ap-guangzhou = 广州地域 ap-shanghai = 上海地域 ap-beijing = 北京地域 示例值:ap-shanghai |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Region | String | 下单region 示例值:ap-shanghai |
Zone | String | 下单zone 示例值:ap-shanghai-1 |
RegionId | Integer | 下单regionId 示例值:4 |
ZoneId | Integer | 下单zoneId 示例值:200001 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 续费环境查询下单地域
续费环境查询下单地域
输入示例
https://tcb.tencentcloudapi.com/?Action=DescribeEnvDealRegion
&EnvId=test-12323
&DealType=ENV_POSTPAY
&DealAction=RENEW
&DealRegion=ap-shanghai
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "3e22b381-93a3-44c4-85b7-456679a7b8cd",
"Region": "ap-shanghai",
"Zone": "ap-shanghai-1",
"RegionId": 4,
"ZoneId": 200001
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
LimitExceeded | 超过配额限制。 |
LimitExceeded.Concurrent | 并发请求超过配额限制。 |
MissingParameter | 缺少参数错误。 |
MissingParameter.Param | 缺少必要参数。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |