tencent cloud

APIs

ModifyImageRegistryTimedScanTaskConfig

Download
Focus Mode
Font Size
Last updated: 2026-09-01 10:54:38

1. API Description

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

Modify the scheduled scan task configuration of an image repository

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: ModifyImageRegistryTimedScanTaskConfig.
Version Yes String Common Params. The value used for this API: 2022-11-21.
Region No String Common Params. This parameter is not required.
MemberId.N No Array of String

Group account member id

Id No Integer

Task ID.

Name No String

Task name.

Enable No Boolean

Whether to enable

ScanType.N No Array of String

Scan category

Enumeration values:

  • CVE: vulnerability
  • RISK: risk
  • VIRUS: Trojan
Schedule No ImageScanScheduleConfig

Scheduled task scheduling configuration

Target No ImageScanAssetTarget

Scan target image filter configuration

Filter No ImageScanRegistryFilter

Mirror filter configuration

Timeout No Integer

Timeout period, in seconds

3. Output Parameters

Parameter Name Type Description
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 scheduled scan task configuration for image repository

Input Example

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

{
    "MemberId": [
        "mem-12e1se11"
    ],
    "Id": 3,
    "Name": "Scheduled scan task 7",
    "Enable": false,
    "ScanType": [
        "VUL"
    ],
    "Schedule": {
        "CycleType": "DAILY",
        "CycleDays": [
            1
        ],
        "StartTime": "16:00",
        "Timezone": "Asia/Shanghai"
    },
    "Target": {
        "Mode": "MANUAL",
        "ExcludeImages": [
            518
        ],
        "Images": [
            573
        ],
        "AutoMatch": {
            "Clusters": [
                "1"
            ]
        }
    },
    "Filter": {
        "RegistryType": [
            "ccr"
        ],
        "Namespace": [
            "openclaw"
        ]
    },
    "Timeout": 1800
}

Output Example

{
    "Response": {
        "RequestId": "ceb5ef9d-f276-4406-b5fc-b0f95083ea6f"
    }
}

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
AuthFailure CAM signature/authentication error.
FailedOperation Operation failed.
InternalError Internal error.
InvalidFilter Invalid Filter
InvalidParameter Parameter error.
InvalidParameter.ResourceId InvalidParameter.ResourceId
InvalidParameterValue Parameter value error.
LimitExceeded The quota limit is exceeded.
MissingParameter Parameters are missing.
OperationDenied Operation denied.
RequestLimitExceeded Number of requests exceeds the frequency limit.
ResourceInUse The resource is occupied.
ResourceNotFound The resource does not exist.
ResourceUnavailable Resources are unavailable.
UnauthorizedOperation.NoPermission UnauthorizedOperation.NoPermission
UnknownParameter Unknown parameter error.

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback