1. 接口描述
接口请求域名: rum.tencentcloudapi.com 。
创建 RUM 业务系统
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateTawInstance。 |
Version | 是 | String | 公共参数,本接口取值:2021-06-22。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
AreaId | 是 | Integer | 片区Id,(至少大于0) 示例值:1 |
ChargeType | 是 | Integer | 计费类型, (1=后付费) 示例值:1 |
DataRetentionDays | 是 | Integer | 数据保存时间,(至少大于0) 示例值:30 |
InstanceName | 是 | String | 实例名称,(最大长度不超过255字节) 示例值:实例名称 |
Tags.N | 否 | Array of Tag | 标签列表 |
InstanceDesc | 否 | String | 实例描述,(最大长度不超过1024字节) 示例值:实例描述 |
CountNum | 否 | String | 每天数据上报量,(不作量级限制) 示例值:100 |
PeriodRetain | 否 | String | 数据存储时长计费 示例值:30 |
BuyingChannel | 否 | String | 实例购买渠道("cdn" 等) 示例值:"" |
ResourcePackageType | 否 | Integer | 预付费资源包类型(仅预付费需要) 示例值:1 |
ResourcePackageNum | 否 | Integer | 预付费资源包数量(仅预付费需要) 示例值:1 |
InstanceType | 否 | Integer | 实例类型 1:原web相关类型 2:app端类型 示例值:1 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
InstanceId | String | 实例Id 示例值:taw-12345678 |
DealName | String | 预付费订单 id 注意:此字段可能返回 null,表示取不到有效值。 示例值:20211011688006794751081 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询实例
创建实例
输入示例
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateTawInstance
<公共请求参数>
{
"AreaId": 1,
"InstanceName": "test",
"ChargeType": 1,
"DataRetentionDays": 30,
"InstanceDesc": "test"
}
输出示例
{
"Response": {
"InstanceId": "taw-4vVPH0Jn",
"DealName": "",
"RequestId": "57f4d8a2-13b6-4ac0-9f0b-0acc7bbc1d61"
}
}
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 | 操作失败。 |
FailedOperation.ChargeNoBalance | 计费相关 - 账户余额不足。 |
FailedOperation.ChargeNoPayRight | 计费相关 - 账户没有付费权限。 |
FailedOperation.ChargeParamInvalid | 计费相关 - 计费参数无效。 |
FailedOperation.InfrastructureError | 第三方依赖异常。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
ResourceNotFound | 资源不存在。 |