1. 接口描述
接口请求域名: iss.tencentcloudapi.com 。
用于修改实时上云计划
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:UpdateRecordPlan。 |
Version | 是 | String | 公共参数,本接口取值:2023-05-17。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
PlanId | 是 | String | 计划ID 示例值:88ac5ea6c1f**24671d0f94f |
Mod | 是 | UpdateRecordPlanData | 修改计划的内容 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Data | RecordPlanOptData | 返回结果 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改计划名称
输入示例
POST / HTTP/1.1
Host: iss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateRecordPlan
<公共请求参数>
{
"PlanId": "88ac5ea6c1f**********24671d0f94f",
"Mod": {
"PlanName": "newname"
}
}
输出示例
{
"Response": {
"Data": {
"PlanId": "88ac5ea6c1f**********24671d0f94f",
"PlanName": "newname",
"TemplateId": "48676e89a8c**********baa36220fa4",
"Describe": "",
"StreamType": "main",
"LifeCycle": {
"Transition": 1,
"Expiration": 60
}
},
"RequestId": "fba7981b-d6a4-4177-b11d-e53a6110e4cd"
}
}
示例2 修改计划模板
输入示例
POST / HTTP/1.1
Host: iss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateRecordPlan
<公共请求参数>
{
"PlanId": "88ac5ea6c1f**********24671d0f94f",
"Mod": {
"TemplateId": "48676e89a8c**********baa36a87832"
}
}
输出示例
{
"Response": {
"Data": {
"PlanId": "88ac5ea6c1f**********24671d0f94f",
"PlanName": "name",
"TemplateId": "48676e89a8c**********baa36a87832",
"Describe": "",
"StreamType": "main",
"LifeCycle": {
"Transition": 1,
"Expiration": 60
}
},
"RequestId": "fba7981b-d6a4-4177-b11d-e53a6110e4cd"
}
}
示例3 删除计划通道
输入示例
POST / HTTP/1.1
Host: iss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateRecordPlan
<公共请求参数>
{
"PlanId": "88ac5ea6c1f**********24671d0f94f",
"Mod": {
"Del": [
"9ee325e9984**********a805c19b4e1"
]
}
}
输出示例
{
"Response": {
"Data": {
"PlanId": "88ac5ea6c1f**********24671d0f94f",
"PlanName": "name",
"TemplateId": "48676e89a8c**********baa36220fa4",
"Describe": "",
"StreamType": "main",
"LifeCycle": {
"Transition": 1,
"Expiration": 60
}
},
"RequestId": "fba7981b-d6a4-4177-b11d-e53a6110e4cd"
}
}
示例4 增加计划通道
输入示例
POST / HTTP/1.1
Host: iss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateRecordPlan
<公共请求参数>
{
"PlanId": "88ac5ea6c1f**********24671d0f94f",
"Mod": {
"Add": [
{
"DeviceId": "9ee325e9984**********a805c19b4e1",
"ChannelId": "48676e89a8c**********baa36220fa4"
}
]
}
}
输出示例
{
"Response": {
"Data": {
"PlanId": "88ac5ea6c1f**********24671d0f94f",
"PlanName": "name",
"TemplateId": "48676e89a8c**********baa36220fa4",
"Describe": "",
"StreamType": "main",
"LifeCycle": {
"Transition": 1,
"Expiration": 60
}
},
"RequestId": "fba7981b-d6a4-4177-b11d-e53a6110e4cd"
}
}
示例5 修改计划生命周期
输入示例
POST / HTTP/1.1
Host: iss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateRecordPlan
<公共请求参数>
{
"PlanId": "88ac5ea6c1f**********24671d0f94f",
"Mod": {
"LifeCycle": {
"Transition": 7,
"Expiration": 80
}
}
}
输出示例
{
"Response": {
"Data": {
"PlanId": "88ac5ea6c1f**********24671d0f94f",
"PlanName": "name",
"TemplateId": "48676e89a8c**********baa36220fa4",
"Describe": "",
"StreamType": "main",
"LifeCycle": {
"Transition": 7,
"Expiration": 80
}
},
"RequestId": "fba7981b-d6a4-4177-b11d-e53a6110e4cd"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败 |
InvalidParameter.InvalidBodyFormat | 无效的消息体格式 |
InvalidParameter.InvalidChannels | 无效的通道参数 |
InvalidParameter.InvalidLifeRuleParam | 无效的生命周期参数 |
InvalidParameter.InvalidOrganizationParam | 无效的组织参数 |
InvalidParameterValue.EmptyChannelId | 通道ID不能为空 |
InvalidParameterValue.EmptyDeviceId | 设备ID不能为空 |
InvalidParameterValue.EmptyName | 名称不能为空 |
InvalidParameterValue.EmptyOrganizationId | 组织ID不能为空 |
InvalidParameterValue.IllegalChannelId | 通道ID包含了非法字符 |
InvalidParameterValue.IllegalDescribe | 描述中包含不符合要求的字符(仅支持中文、英文、数字、_、-) |
InvalidParameterValue.IllegalDeviceId | 设备ID包含了非法字符 |
InvalidParameterValue.IllegalName | 名称中包含不符合要求的字符(仅支持中文、英文、数字、_、-) |
InvalidParameterValue.IllegalOrganizationId | 组织ID包含了非法字符 |
InvalidParameterValue.IllegalStreamType | 码流类型包含非法字符(仅支持英文、数字、_、-) |
InvalidParameterValue.InvalidChannelId | 无效的通道ID |
InvalidParameterValue.InvalidChannelIdOrDeviceId | 包含无效的通道ID或者设备ID |
InvalidParameterValue.InvalidDeviceId | 无效的设备ID |
InvalidParameterValue.InvalidExpirationRange | 冷存储至少60天, 并且热存储和冷存储总天数不能超过3650天 |
InvalidParameterValue.InvalidPlanId | 无效的计划ID |
InvalidParameterValue.InvalidTemplateId | 无效的模板ID |
InvalidParameterValue.InvalidTransitionRange | 热存储至少1天, 最多3650天 |
InvalidParameterValue.PlanChannelsExceedsRange | 通道数量一次最多添加5000路 |
InvalidParameterValue.TooLongDescribe | 描述字段过长 |
InvalidParameterValue.TooLongName | 名称过长 |
InvalidParameterValue.TooLongStreamType | 码流类型过长 |
MissingParameter.MissingLifeRuleParam | 缺少生命周期参数 |
MissingParameter.MissingUpdatedInfo | 没有更新信息 |
ResourceInUse.ChannelRepeatAdd | 存在重复添加的通道 |
ResourceInUse.PlanDeleting | 计划删除中无法修改 |
ResourceInUse.PlanNameRepeat | 计划名称不能重复 |
ResourceNotFound.OrganizationIdNotExist | 组织ID不存在 |
ResourceNotFound.PlanNotExist | 计划不存在 |
ResourceNotFound.TemplateNotExist | 模板不存在 |