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

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

POST /autopilot/v2/namespaces/{namespace}/patrol-reports/trigger HTTP/1.1

Path Parameters

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

Request parameters

Parameter	Type	Required	Description	Example
workspace	string	Yes	The workspace ID.	a14bd5d90a****
body	object	No	The request body for triggering an inspection.
scopeType	string	Yes	The inspection scope type. Valid values: ALL : All deployments. DEPLOYMENTS : Specified deployments. TAGS : Deployments filtered by tags.	ALL
scopeConfig	object	No	The inspection scope configuration.
deploymentIds	array	No	The list of deployment IDs. Valid only when scopeType is set to DEPLOYMENTS.
	string	No	The deployment ID.	00000000-0000-0000-0000-0000012312****
tags	object	No	The tag mapping. 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"]

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 always 200. Use success to determine whether the request is successful.	200
errorCode	string	The business error code. This value is not empty when success is false, and is empty when success is true.	""
errorMessage	string	The business error message. This value is not empty when success is false, and is empty when success is true.	""
data	object	The response data for triggering an inspection.
reportId	string	The ID of the generated report.	inspection-cf8f8843-64e4-4b45-9500-06790107130f
status	string	The report status. Valid values: IN_PROGRESS : In progress. COMPLETED : Completed. FAILED : Failed. PENDING : Pending.	COMPLETED

Examples

Success response

JSON format

{
  "requestId": "CBC799F0-AS7S-1D30-8A4F-882ED4DD****",
  "success": true,
  "httpCode": 200,
  "errorCode": "\"\"",
  "errorMessage": "\"\"",
  "data": {
    "reportId": "inspection-cf8f8843-64e4-4b45-9500-06790107130f",
    "status": "COMPLETED"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.