UpdatePatrolConfig - Realtime Compute for Apache Flink - Alibaba Cloud Documentation Center

Updates the inspection configuration.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

PATCH /autopilot/v2/namespaces/{namespace}/patrol-config HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
namespace	string	Yes	The project workspace name.	default-namespace

Request parameters

Parameter	Type	Required	Description	Example
workspace	string	Yes	The workspace ID.	a14bda1c4a****
body	object	No	The request body for updating the inspection configuration.
cron	string	No	The Cron expression that defines the inspection schedule.	0 2 * * *
timezone	string	No	The time zone.	Asia/Shanghai
scopeType	string	No	The inspection scope type. Valid values: ALL : All deployments. DEPLOYMENTS : Specified deployments. TAGS : Deployments filtered by tag.	ALL
scopeConfig	object	No	The inspection scope configuration.
deploymentIds	array	No	The list of deployment IDs. This parameter is valid only when scopeType is set to DEPLOYMENTS.
	string	No	The deployment ID.	00000000-0000-0000-0000-0000012312****
tags	object	No	The tag mapping. This parameter is valid only when scopeType is set to TAGS. The key is the tag name, and the value is a list of tag values.
	array	No	The key-value pair of the tag.
	string	No	The tag value.	"tag_key": ["v1", "v2"]
enabled	boolean	No	Specifies whether to enable inspection.	true

Response elements

Element	Type	Description	Example
	object	The response data.
requestId	string	The request ID.	CBC799F0-AS7S-1D30-8A4F-882ED4DD****
success	boolean	Indicates whether the business request is successful.	true
httpCode	integer	The business status code, which is uniformly set to 200. The success parameter indicates whether the business request is successful.	200
errorCode	string	The business error code. This parameter is not empty when success is false, and is empty when success is true.	""
errorMessage	string	The business error message. This parameter is not empty when success is false, and is empty when success is true.	""
data	object	The response data for the inspection configuration.
workspace	string	The workspace ID.	a14bda1c4a****
namespace	string	The project workspace name.	default-namespace
cron	string	The Cron expression that defines the inspection schedule.	0 2 * * *
timezone	string	The time zone.	Asia/Shanghai
scopeType	string	The inspection scope type. Valid values: ALL : All deployments. DEPLOYMENTS : Specified deployments. TAGS : Deployments filtered by tag.	ALL
scopeConfig	object	The inspection scope configuration.
deploymentIds	array	The list of deployment IDs. This parameter is valid only when scopeType is set to DEPLOYMENTS.
	string	The deployment ID.	00000000-0000-0000-0000-0000012312****
tags	object	The tag mapping. This parameter is valid only when scopeType is set to TAGS. The key is the tag name, and the value is a list of tag values.
	array	The tag key-value pair.
	string	The tag value.	"tag_key": ["v1", "v2"]
enabled	boolean	Specifies whether to enable inspection.	true
nextPatrolAt	integer	The next inspection time. The value is a millisecond timestamp.	1756260000000
configCreatedAt	integer	The configuration creation time. The value is a millisecond timestamp.	1756200000000
configUpdatedAt	integer	The configuration update time. The value is a millisecond timestamp.	1756250000000

Examples

Success response

JSON format

{
  "requestId": "CBC799F0-AS7S-1D30-8A4F-882ED4DD****",
  "success": true,
  "httpCode": 200,
  "errorCode": "\"\"",
  "errorMessage": "\"\"",
  "data": {
    "workspace": "a14bda1c4a****",
    "namespace": "default-namespace",
    "cron": "0 2 * * *",
    "timezone": "Asia/Shanghai",
    "scopeType": "ALL",
    "scopeConfig": {
      "deploymentIds": [
        "00000000-0000-0000-0000-0000012312****"
      ],
      "tags": {
        "key": [
          "\"tag_key\": [\"v1\", \"v2\"]"
        ]
      }
    },
    "enabled": true,
    "nextPatrolAt": 1756260000000,
    "configCreatedAt": 1756200000000,
    "configUpdatedAt": 1756250000000
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.