GetPatrolReportDetail - Realtime Compute for Apache Flink

Retrieves the details of an inspection report.

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

get

*All Resource

*

None

Request syntax

GET /autopilot/v2/namespaces/{namespace}/patrol-reports/details 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****
reportId	string	No	The report ID. Mutually exclusive with date, with reportId taking precedence.	d72edfd9f3ef475ca310456ecdb09fe8
date	string	No	The report date in ISO format such as 2026-08-13, or special values such as today or yesterday. Mutually exclusive with reportId. Used to retrieve the latest report for a specified date.	20260416
timezone	string	No	The time zone, used in conjunction with date. Default value: UTC.	UTC

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 the success field to determine 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 report details.
workspace	string	The workspace ID.	a14bd5d90a****
namespace	string	The project workspace name.	default-namespace
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 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"]
overview	object	The inspection overview.
total	integer	The total number of jobs.	1
riskSummary	object	The risk summary.
critical	integer	The number of jobs at the Critical level.	0
warning	integer	The number of jobs at the Warning level.	1
info	integer	The number of jobs at the Info level.	0
problemSummary	object	The problem summary.
unhealthy	integer	The number of unhealthy jobs.	0
delayAndBackpressure	integer	The number of jobs with delay and backpressure.	0
unhealthyCheckpoints	integer	The number of jobs with unhealthy checkpoints.	0
reportId	string	The report ID.	inspection-cf8f8843-64e4-4b45-9500-06790107130f
unhealthyJobs	array<object>	The list of unhealthy jobs.
	object
deploymentId	string	The deployment ID.	18b8ceaa-207d-417b-833e-a5845bb31beb
jobId	string	The job ID.	db201864-e0df-4f8c-81f0-d62103095ff6
deploymentName	string	The deployment name.	rlt_cust_no_apitime
description	string	The problem description.	Job backpressure
analysis	string	The analysis.	The job has experienced continuous backpressure in the last 30 minutes.
riskLevel	string	The risk level.	info
recommendation	string	The recommendation.	Check the processing capacity of the downstream operator.
tags	array	The list of tags diagnosed by AI for the job.
	string	The problem tag diagnosed by AI for the job.	["backpressure", "high_checkpoint_latency"]
createdAt	string	The creation time. The value is a UNIX timestamp in milliseconds.	1772936711518
updatedAt	string	The update time. The value is a UNIX timestamp in milliseconds.	1758248445816
completedAt	string	The completion time.	1785981634652

Examples

Success response

JSON format

{
  "requestId": "CBC799F0-AS7S-1D30-8A4F-882ED4DD****",
  "success": true,
  "httpCode": 200,
  "errorCode": "\"\"",
  "errorMessage": "\"\"",
  "data": {
    "workspace": "a14bd5d90a****",
    "namespace": "default-namespace",
    "triggerType": "CRON",
    "scopeType": "ALL",
    "scopeConfig": {
      "deploymentIds": [
        "00000000-0000-0000-0000-0000012312****"
      ],
      "tags": {
        "key": [
          "\"tag_key\": [\"v1\", \"v2\"]"
        ]
      }
    },
    "overview": {
      "total": 1,
      "riskSummary": {
        "critical": 0,
        "warning": 1,
        "info": 0
      },
      "problemSummary": {
        "unhealthy": 0,
        "delayAndBackpressure": 0,
        "unhealthyCheckpoints": 0
      }
    },
    "reportId": "inspection-cf8f8843-64e4-4b45-9500-06790107130f",
    "unhealthyJobs": [
      {
        "deploymentId": "18b8ceaa-207d-417b-833e-a5845bb31beb",
        "jobId": "db201864-e0df-4f8c-81f0-d62103095ff6",
        "deploymentName": "rlt_cust_no_apitime",
        "description": "Job backpressure",
        "analysis": "The job has experienced continuous backpressure in the last 30 minutes.",
        "riskLevel": "info",
        "recommendation": "Check the processing capacity of the downstream operator.",
        "tags": [
          "[\"backpressure\", \"high_checkpoint_latency\"]"
        ]
      }
    ],
    "createdAt": "1772936711518",
    "updatedAt": "1758248445816",
    "completedAt": "1785981634652"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.