有奖:语音产品征文挑战赛火热进行中> HOT

1. 接口描述

接口请求域名: tem.tencentcloudapi.com 。

编辑环境

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyEnvironment。
Version String 公共参数,本接口取值:2021-07-01。
Region String 公共参数,详见产品支持的 地域列表
EnvironmentId String 环境id
示例值:namespace-36pm4p8r
EnvironmentName String 环境名称
示例值:namespace-a
Description String 环境描述
示例值:命名空间
Vpc String 私有网络名称
示例值:vpc-1n5javez
SubnetIds.N Array of String 子网网络
示例值:subnet-m48cb76m
SourceChannel Integer 来源渠道
示例值:0
EnvType String 环境类型:test、pre、prod
示例值:test

3. 输出参数

参数名称 类型 描述
Result Boolean 成功时为环境ID,失败为null
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 编辑环境

编辑环境

输入示例

POST / HTTP/1.1
Host: tem.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyEnvironment
<公共请求参数>

{
    "EnvironmentName": "xx",
    "Description": "xx",
    "EnvironmentId": "xx",
    "SubnetIds": [
        "xx"
    ],
    "SourceChannel": 0,
    "Vpc": "xx"
}

输出示例

{
    "Response": {
        "Result": true,
        "RequestId": "xx"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError.AddNewNodeError 添加子网/虚拟节点异常。
InternalError.DefaultInternalError 服务器繁忙,请稍后再试。
InvalidParameterValue.EnvironmentNameImmutable 环境名称不可变。
InvalidParameterValue.TemIdInvalid 不是合法的TEM ID。
OperationDenied.ResourceIsolated 账号欠费状态下不支持该操作,请冲正后重试。
ResourceNotFound.VersionNamespaceNotFound 找不到版本对应的环境。
UnauthorizedOperation.UnauthorizedOperation 未授权。