1. 接口描述
接口请求域名： tat.tencentcloudapi.com 。
此接口用于预览自定义参数替换后的命令内容。不会触发真实执行。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：PreviewReplacedCommandContent。 |
| Version | 是 | String | 公共参数，本接口取值：2020-10-28。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Parameters | 否 | String | 本次预览采用的自定义参数。字段类型为 json encoded string，如：{"varA": "222"}。 key 为自定义参数名称，value 为该参数的取值。kv 均为字符串型。 自定义参数最多 20 个。 自定义参数名称需符合以下规范：字符数目上限 64，可选范围【a-zA-Z0-9-_】。 如果将预览的 CommandId 设置过 DefaultParameters，本参数可以为空。 示例值：{"varA": "222"} |
| CommandId | 否 | String | 要进行替换预览的命令，如果有设置过 DefaultParameters，会与 Parameters 进行叠加，后者覆盖前者。 CommandId 与 Content，必须且只能提供一个。 示例值：cmd-abcdefgh |
| Content | 否 | String | 要预览的命令内容，经 Base64 编码，长度不可超过 64KB。 CommandId 与 Content，必须且只能提供一个。 示例值：bHMge3thfX0KZWNobyB7e2J9fQ== |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ReplacedContent | String | 自定义参数替换后的，经Base64编码的命令内容。 示例值：bHMge3thfX0KZWNobyB7e2J9fQ== |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 预览content替换
输入示例
POST / HTTP/1.1
Host: tat.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: PreviewReplacedCommandContent
<公共请求参数>
{
"Parameters": "{\"a\": \"123\"}",
"Content": "bHMge3thfX0KZWNobyB7e2J9fSB7e2N9fQ=="
}输出示例
{
"Response": {
"RequestId": "0b4c6010-42a7-45cd-b8c3-daa7de930e82",
"ReplacedContent": "bHMgMTIzCmVjaG8ge3tifX0ge3tjfX0="
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter.ConflictParameter | 参数冲突。 |
| InvalidParameter.ParameterNameDuplicated | 参数名称重复。 |
| InvalidParameterValue.CommandContentInvalid | Command 内容无效。 |
| InvalidParameterValue.CommandNameDuplicated | Command 名称重复。 |
| InvalidParameterValue.InvalidCommandId | CommandId 无效。 |
| InvalidParameterValue.LackOfParameterInfo | 已启用自定义参数功能，但缺失自定义参数信息。 |
| InvalidParameterValue.LackOfParameters | 未提供 Parameters 信息。 |
| InvalidParameterValue.ParameterDisabled | 未启用自定义参数功能。 |
| InvalidParameterValue.ParameterInvalidJsonFormat | 参数为非法 json string 格式。 |
| InvalidParameterValue.ParameterKeyContainsInvalidChar | 参数 Key 包含非法字符。 |
| InvalidParameterValue.ParameterKeyDuplicated | 参数 Key 重复。 |
| InvalidParameterValue.ParameterKeyLenExceeded | 参数 Key 过长。 |
| InvalidParameterValue.ParameterNumberExceeded | 参数数目过多。 |
| InvalidParameterValue.ParameterValueNotString | 参数 Value 非 string 类型。 |
| InvalidParameterValue.Range | 参数取值范围不合法。 |
| InvalidParameterValue.SupportParametersOnlyIfEnableParameter | 未启用自定义参数功能。 |
| ResourceNotFound.CommandNotFound | 命令不存在。 |
| UnauthorizedOperation.CamAuthFailed | CAM鉴权失败。 |
| UnauthorizedOperation.InvalidToken | Token 无效。 |
| UnauthorizedOperation.MFAExpired | Multi-Factor Authentication(MFA) 过期。 |
| UnauthorizedOperation.MFANotFound | Multi-Factor Authentication(MFA) 不存在。 |
