tencent cloud

APIs

ドキュメントAPIsIntelligent Surveillance StorageRecording Schedule APIsUpdateRecordPlan

UpdateRecordPlan

ダウンロード
フォーカスモード
フォントサイズ
最終更新日: 2026-10-26 11:48:32

1. API Description

Domain name for API request: iss.intl.tencentcloudapi.com.

This API is used to modify a real-time cloud migration plan.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: UpdateRecordPlan.
Version Yes String Common Params. The value used for this API: 2023-05-17.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
PlanId Yes String Plan ID
Mod Yes UpdateRecordPlanData Modify the content of the plan

3. Output Parameters

Parameter Name Type Description
Data RecordPlanOptData Returned result
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Modify the plan name

Input Example

POST / HTTP/1.1
Host: iss.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateRecordPlan
<Common request parameters>

{
    "PlanId": "88ac5ea6c1f**********24671d0f94f",
    "Mod": {
        "PlanName": "newname"
    }
}

Output Example

{
    "Response": {
        "Data": {
            "PlanId": "88ac5ea6c1f**********24671d0f94f",
            "PlanName": "newname",
            "TemplateId": "48676e89a8c**********baa36220fa4",
            "Describe": "",
            "RepairMode": 0,
            "StreamType": "main",
            "LifeCycle": {
                "Transition": 1,
                "Expiration": 60
            }
        },
        "RequestId": "fba7981b-d6a4-4177-b11d-e53a6110e4cd"
    }
}

Example2 Modify a plan template

Input Example

POST / HTTP/1.1
Host: iss.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateRecordPlan
<Common request parameters>

{
    "PlanId": "88ac5ea6c1f**********24671d0f94f",
    "Mod": {
        "TemplateId": "48676e89a8c**********baa36a87832"
    }
}

Output Example

{
    "Response": {
        "Data": {
            "PlanId": "88ac5ea6c1f**********24671d0f94f",
            "PlanName": "name",
            "TemplateId": "48676e89a8c**********baa36a87832",
            "Describe": "",
            "RepairMode": 0,
            "StreamType": "main",
            "LifeCycle": {
                "Transition": 1,
                "Expiration": 60
            }
        },
        "RequestId": "fba7981b-d6a4-4177-b11d-e53a6110e4cd"
    }
}

Example3 Delete a plan channel

Input Example

POST / HTTP/1.1
Host: iss.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateRecordPlan
<Common request parameters>

{
    "PlanId": "88ac5ea6c1f**********24671d0f94f",
    "Mod": {
        "Del": [
            "9ee325e9984**********a805c19b4e1"
        ]
    }
}

Output Example

{
    "Response": {
        "Data": {
            "PlanId": "88ac5ea6c1f**********24671d0f94f",
            "PlanName": "name",
            "TemplateId": "48676e89a8c**********baa36220fa4",
            "Describe": "",
            "RepairMode": 0,
            "StreamType": "main",
            "LifeCycle": {
                "Transition": 1,
                "Expiration": 60
            }
        },
        "RequestId": "fba7981b-d6a4-4177-b11d-e53a6110e4cd"
    }
}

Example4 Add a planned channel

Input Example

POST / HTTP/1.1
Host: iss.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateRecordPlan
<Common request parameters>

{
    "PlanId": "88ac5ea6c1f**********24671d0f94f",
    "Mod": {
        "Add": [
            {
                "DeviceId": "9ee325e9984**********a805c19b4e1",
                "ChannelId": "48676e89a8c**********baa36220fa4"
            }
        ]
    }
}

Output Example

{
    "Response": {
        "Data": {
            "PlanId": "88ac5ea6c1f**********24671d0f94f",
            "PlanName": "name",
            "TemplateId": "48676e89a8c**********baa36220fa4",
            "Describe": "",
            "RepairMode": 0,
            "StreamType": "main",
            "LifeCycle": {
                "Transition": 1,
                "Expiration": 60
            }
        },
        "RequestId": "fba7981b-d6a4-4177-b11d-e53a6110e4cd"
    }
}

Example5 Modify Plan Lifecycle

Input Example

POST / HTTP/1.1
Host: iss.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateRecordPlan
<Common request parameters>

{
    "PlanId": "88ac5ea6c1f**********24671d0f94f",
    "Mod": {
        "LifeCycle": {
            "Transition": 7,
            "Expiration": 80
        }
    }
}

Output Example

{
    "Response": {
        "Data": {
            "PlanId": "88ac5ea6c1f**********24671d0f94f",
            "PlanName": "name",
            "TemplateId": "48676e89a8c**********baa36220fa4",
            "Describe": "",
            "RepairMode": 0,
            "StreamType": "main",
            "LifeCycle": {
                "Transition": 7,
                "Expiration": 80
            }
        },
        "RequestId": "fba7981b-d6a4-4177-b11d-e53a6110e4cd"
    }
}

Example6 Modify the Video Recording Supplement Mode

Input Example

POST / HTTP/1.1
Host: iss.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateRecordPlan
<Common request parameters>

{
    "PlanId": "88ac5ea6c1f**********24671d0f94f",
    "Mod": {
        "RepairMode": 1
    }
}

Output Example

{
    "Response": {
        "Data": {
            "PlanId": "88ac5ea6c1f**********24671d0f94f",
            "PlanName": "name",
            "TemplateId": "48676e89a8c**********baa36220fa4",
            "Describe": "",
            "RepairMode": 1,
            "StreamType": "main",
            "LifeCycle": {
                "Transition": 7,
                "Expiration": 80
            }
        },
        "RequestId": "fba7981b-d6a4-4177-b11d-e53a6110e4cd"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation Operation failed
InvalidParameter.InvalidBodyFormat Invalid message body format
InvalidParameter.InvalidChannels Invalid channel parameters
InvalidParameter.InvalidLifeRuleParam Invalid lifecycle parameter
InvalidParameter.InvalidOrganizationParam Invalid organization parameter
InvalidParameterValue.EmptyChannelId Channel ID cannot be empty.
InvalidParameterValue.EmptyDeviceId Device ID cannot be empty.
InvalidParameterValue.EmptyName Name cannot be empty
InvalidParameterValue.EmptyOrganizationId Organization ID cannot be empty.
InvalidParameterValue.IllegalChannelId Channel ID contains illegal characters
InvalidParameterValue.IllegalDescribe Description contains non-compliant characters (only Chinese, English, digits, _, and - are supported)
InvalidParameterValue.IllegalDeviceId Device ID contains illegal characters
InvalidParameterValue.IllegalName Name contains non-compliant characters (only Chinese, English, digits, _, and - are supported)
InvalidParameterValue.IllegalOrganizationId Organization ID contains illegal characters
InvalidParameterValue.IllegalStreamType Stream type contains invalid characters (only English, digits, _, and - are supported)
InvalidParameterValue.InvalidChannelId Invalid channel ID
InvalidParameterValue.InvalidChannelIdOrDeviceId Contains an invalid channel ID or device ID
InvalidParameterValue.InvalidDeviceId Invalid device ID
InvalidParameterValue.InvalidExpirationRange Cold storage must be at least 60 days, and the total days of hot and cold storage cannot exceed 3650 days.
InvalidParameterValue.InvalidPlanId Invalid plan ID
InvalidParameterValue.InvalidRepairMode Invalid video recording supplement parameter
InvalidParameterValue.InvalidTemplateId Invalid template ID
InvalidParameterValue.InvalidTransitionRange Hot storage must be at least 1 day and at most 3650 days.
InvalidParameterValue.LimitRepairTransition Enable video recording supplementary hot storage for at least 3 days.
InvalidParameterValue.PlanChannelsExceedsRange Add up to 5,000 channels at a time
InvalidParameterValue.TooLongDescribe Description field too long
InvalidParameterValue.TooLongName Name is too long
InvalidParameterValue.TooLongStreamType Stream type too long.
MissingParameter.MissingLifeRuleParam Lack of lifecycle parameters
MissingParameter.MissingUpdatedInfo No update information.
ResourceInUse.ChannelRepeatAdd Existent channel with duplicate addition
ResourceInUse.PlanDeleting Cannot be modified during scheduled deletion.
ResourceInUse.PlanNameRepeat Plan name must be unique
ResourceNotFound.OrganizationIdNotExist Organization ID does not exist.
ResourceNotFound.PlanNotExist Plan not found
ResourceNotFound.TemplateNotExist The template does not exist.
前の記事へ: DeleteRecordPlan次の記事へ: DescribeRecordPlan

ヘルプとサポート

この記事はお役に立ちましたか？

フィードバック

キーワードで検索
    Enter keywords to search documentation