GetAutopilotPolicy - 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

GET /autopilot/v2/namespaces/{namespace}/deployments/{deploymentId}/autopilotpolicy-describe HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
namespace	string	Yes	The project space name.	test-flink-bigdata-default
deploymentId	string	Yes	The job ID.	5737ef81-d2f1-49cf-8752-30910809****

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 request is successful.	true
httpCode	integer	The business status code, which is always 200. Use the success field to determine whether the request is successful.	200
errorCode	string	The error code. This field is not empty when success is false. This field is empty when success is true.	""
errorMessage	string	The error message. This field is not empty when success is false. This field is empty when success is true.	""
data	object	The Autopilot tuning policy response data.
enabled	boolean	Indicates whether automatic tuning is enabled. A value of true indicates that automatic tuning is active (ACTIVE). A value of false indicates that tuning is not enabled.	false
policyConfig	AutopilotPolicy	The tuning policy configuration.

Examples

Success response

JSON format

{
  "requestId": "CBC799F0-AS7S-1D30-8A4F-882ED4DD****",
  "success": true,
  "httpCode": 200,
  "errorCode": "\"\"",
  "errorMessage": "\"\"",
  "data": {
    "enabled": false,
    "policyConfig": {
      "limits": {
        "coolDownMinutes": 0,
        "jobMaxCpu": 0,
        "jobMaxMemory": "",
        "jobMaxParallelism": 0,
        "jobMinParallelism": 0
      },
      "silentPeriodConfig": {
        "enabled": false,
        "silentPeriods": [
          {
            "level": "",
            "beginTime": 0,
            "endTime": 0
          }
        ]
      },
      "scaleUpRules": {
        "delayRule": {
          "enabled": false,
          "delaySampleInterval": "",
          "delayThreshold": ""
        },
        "slotBusyScaleUpRule": {
          "enabled": false,
          "slotBusyScaleUpSampleInterval": "",
          "slotBusyScaleUpThreshold": 0
        },
        "memoryScaleUpRule": {
          "enabled": false,
          "memUsageScaleUpThreshold": 0
        },
        "oomScaleUpRule": {
          "enabled": false
        },
        "gcRule": {
          "enabled": false,
          "gcTimeRatioThreshold": 0,
          "gcSampleInterval": ""
        }
      },
      "scaleDownRules": {
        "slotBusyScaleDownRule": {
          "enabled": false,
          "slotBusyScaleDownSampleInterval": "",
          "slotBusyScaleDownThreshold": 0
        },
        "memoryScaleDownRule": {
          "enabled": false,
          "memUsageScaleDownThreshold": 0,
          "memUsageScaleDownSampleInterval": ""
        }
      },
      "advancedRules": {
        "enabled": false,
        "parameters": {
          "key": ""
        }
      }
    }
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.