1. 接口描述
接口请求域名: ssm.tencentcloudapi.com 。
开通 ssm 服务接口
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateService。 |
| Version | 是 | String | 公共参数,本接口取值:2019-09-23。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| PayMode | 是 | String | 仅支持 PostPay,区分大小写 枚举值:
仅支持 PostPay,区分大小写 示例值:PostPay |
| ClientToken | 是 | String | 客户端生成的创建请求标识。同一次逻辑创建发生重试时,须使用相同的值。 参数格式:1~64 个可见 ASCII 字符(! 至 ~)。 入参限制:必填;不能含空格、中文或控制字符。建议使用 ssm-<UUID>,不要包含密钥或个人信息。 默认值:留空,由调用方生成;不要设置固定默认值。 SSM 将其透传给计费侧,不存储或返回。订单状态不明时先核单,再决定是否用原值重试。 示例值:123344 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ResourceId | String | 义SSM 服务资源 ID,供调用方保存并标识该服务资源。 参数格式:一期后付费为 ssm_ 加 AppId,如 ssm_1250000000。 默认值:留空。 返回时资源可能仍在发货,不代表服务已可用。 示例值:ssm_260210396 |
| OrderId | String | 计费交易订单号,用于核对本次开通订单 参数格式:留空;不承诺固定长度或纯数字格式。 默认值:留空。 来自计费返回的订单号;订单形成不代表发货完成。 示例值:20260918311023705882391 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 开通 ssm 服务
输入示例
POST / HTTP/1.1
Host: ssm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateService
<公共请求参数>
{
"PayMode": "PostPay",
"ClientToken": "123344"
}
输出示例
{
"Response": {
"OrderId": "20260918311023705882391",
"ResourceId": "ssm_260210396",
"RequestId": "444eec98-00e2-42a1-87fe-8304b7500aa9"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameterValue | 参数取值错误。 |
| ResourceInUse.ServiceAlreadyEnabled | 服务已经被开通 |
| UnauthorizedOperation | 未授权操作。 |