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

Queries a list of inspection reports.

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:ListPatrolReports

none

*All Resource

*

None

Request syntax

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

Path Parameters

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

Request parameters

Parameter	Type	Required	Description	Example
workspace	string	Yes	The workspace ID.	a14bd5d90a****
startDate	integer	No	The start time of the query. The value is a UNIX timestamp in milliseconds.	1718000000000
endDate	integer	No	The end time of the query. The value is a UNIX timestamp in milliseconds.	1718086400000
status	string	No	The report status filter. Valid values: PENDING, IN_PROGRESS, COMPLETED, and FAILED. Valid values: IN_PROGRESS : In progress. COMPLETED : Completed. FAILED : Failed. PENDING : Pending.	PENDING
scopeType	string	No	The inspection scope type filter. Valid values: ALL, TAGS, and DEPLOYMENTS. Valid values: ALL : All deployments. DEPLOYMENTS : Specified deployments. TAGS : Deployments filtered by tag.	ALL
triggerType	string	No	The trigger type filter. Valid values: CRON, MANUAL, and INNER_API. Valid values: CRON : Scheduled trigger. INNER_API : Internal API trigger. MANUAL : Manual trigger.	CRON
page	integer	No	The page number. Pages start from 1. Default value: 1.	1
size	integer	No	The number of entries per page. Default value: 20. Maximum value: 200.	20

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 request is successful.	true
httpCode	integer	The business status code, which is always 200. Use the success field to indicate whether the request is successful.	200
errorCode	string	The business error code. This field is not empty when success is false and is empty when success is true.	""
errorMessage	string	The business error message. This field is not empty when success is false and is empty when success is true.	""
data	object	The paged inspection report data.
items	array<object>	The list of inspection reports.
	array<object>	The inspection report.
reportId	string	The report ID.	e7fd2601edc24a37baaba7eec5f64312
workspace	string	The workspace ID.	a14bd5d90a****
namespace	string	The namespace.	default-namespace
status	string	The report status. Valid values: IN_PROGRESS : In progress. COMPLETED : Completed. FAILED : Failed. PENDING : Pending.	PENDING
totalJobs	integer	The total number of jobs.	5
inspectedJobs	integer	The number of inspected jobs.	2
riskCriticalCount	integer	The number of jobs with a Critical risk level.	0
riskWarningCount	integer	The number of jobs with a Warning risk level.	1
riskInfoCount	integer	The number of jobs with an Info risk level.	1
problemUnhealthyCount	integer	The number of unhealthy jobs.	1
problemDelayBackpressureCount	integer	The number of jobs with latency and backpressure issues.	1
problemUnhealthyCheckpointCount	integer	The number of jobs with unhealthy checkpoints.	0
errorMessage	string	The error message.	""
triggerType	string	The trigger type. Valid values: CRON : Scheduled trigger. INNER_API : Internal API trigger. MANUAL : Manual trigger.	CRON
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 field is valid only when scopeType is set to DEPLOYMENTS.
	string	The deployment ID.	00000000-0000-0000-0000-0000012312****
tags	object	The tag mapping. This field 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"]
startedAt	string	The inspection start time.	1755158793586
completedAt	string	The inspection completion time.	1785981634652
createdAt	string	The creation time. The value is a UNIX timestamp in milliseconds.	1755158793586
updatedAt	string	The update time. The value is a UNIX timestamp in milliseconds.	1784168829417
total	integer	The total number of entries.	5
page	integer	The current page number.	1
size	integer	The number of entries per page.	20

Examples

Success response

JSON format

{
  "requestId": "CBC799F0-AS7S-1D30-8A4F-882ED4DD****",
  "success": true,
  "httpCode": 200,
  "errorCode": "\"\"",
  "errorMessage": "\"\"",
  "data": {
    "items": [
      {
        "reportId": "e7fd2601edc24a37baaba7eec5f64312",
        "workspace": "a14bd5d90a****",
        "namespace": "default-namespace",
        "status": "PENDING",
        "totalJobs": 5,
        "inspectedJobs": 2,
        "riskCriticalCount": 0,
        "riskWarningCount": 1,
        "riskInfoCount": 1,
        "problemUnhealthyCount": 1,
        "problemDelayBackpressureCount": 1,
        "problemUnhealthyCheckpointCount": 0,
        "errorMessage": "\"\"",
        "triggerType": "CRON",
        "scopeType": "ALL",
        "scopeConfig": {
          "deploymentIds": [
            "00000000-0000-0000-0000-0000012312****"
          ],
          "tags": {
            "key": [
              "\"tag_key\": [\"v1\", \"v2\"]"
            ]
          }
        },
        "startedAt": "1755158793586\n",
        "completedAt": "1785981634652",
        "createdAt": "1755158793586",
        "updatedAt": "1784168829417"
      }
    ],
    "total": 5,
    "page": 1,
    "size": 20
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.