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

Retrieves 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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

stream:GetPatrolConfig

get

*All Resource

*

None

Request syntax

GET /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.	a14bd5d90a****

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. The value is always 200. The success field 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 inspection configuration data.
workspace	string	The workspace ID.	edcef******b4f
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: Inspects all deployments. TAGS: Filters deployments by tag. DEPLOYMENTS: Inspects specified deployments. 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 key-value pair of the tag.
	string	The tag value.	"tag_key": ["v1", "v2"]
enabled	boolean	Indicates whether the inspection is enabled.	true
nextPatrolAt	integer	The time of the next inspection. The value is a UNIX timestamp in milliseconds.	1756260000000
configCreatedAt	integer	The time when the configuration was created. The value is a UNIX timestamp in milliseconds.	1756200000000
configUpdatedAt	integer	The time when the configuration was updated. The value is a UNIX timestamp in milliseconds.	1756250000000

Examples

Success response

JSON format

{
  "requestId": "CBC799F0-AS7S-1D30-8A4F-882ED4DD****",
  "success": true,
  "httpCode": 200,
  "errorCode": "\"\"",
  "errorMessage": "\"\"",
  "data": {
    "workspace": "edcef******b4f",
    "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.