Filter Flink Deployments by IP Using GetDeploymentsByIp - Realtime Compute for Apache Flink - Alibaba Cloud - Realtime Compute for Apache Flink

Operation description

Use this operation to query for associated Flink deployments based on the source or destination IP address and port of a network connection.

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

get

*All Resource

*

None

Request syntax

GET /api/v2/namespaces/{namespace}/deployments/getDeployments/byIp HTTP/1.1

Path Parameters

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

Request parameters

Parameter	Type	Required	Description	Example
workspace	string	Yes	The ID of the workspace.	a14bd5d90a****
srcIp	string	No	The source IP address. This parameter is used to match the input source address of a job.	192.168.1.100
srcPort	string	No	The source port. Use this parameter with srcIp for an exact match of the connection.	54321
dstIp	string	No	The destination IP address. This parameter is used to match the destination sink address of a job.	10.100.2.200
dstPort	string	No	The destination port. Use this parameter with dstIp.	9092
ignoreJobSummary	boolean	No	Specifies whether to exclude the job summary from the response. If you exclude the summary, only deployment information is returned. This improves performance. Valid values: true : true false : false	false
ignoreResourceSetting	boolean	No	Specifies whether to exclude resource configuration information. This reduces the size of the returned data. Valid values: true : true false : false	false

You must specify at least one of srcIp or dstIp.
The port parameter is optional and can help narrow the search for a specific job. For a more precise search, use a combination of srcIp and srcPort.
Combined queries are supported. For example, if you specify only dstIp=10.100.2.200, all jobs that write to this IP address are returned. If you specify both srcIp and dstIp, the data link jobs between the two points are returned.
In a production environment, you can set ignoreJobSummary to true or ignoreResourceSetting to true to reduce response latency.

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 was successful.	true
httpCode	integer	The HTTP status code. A value of 200 indicates that the request was successful. Use the success parameter to determine whether the business request was successful.	200
errorCode	string	The error code. This parameter is returned only when success is false. If success is true, this parameter is empty.	""
errorMessage	string	The error message. This parameter is returned only when success is false. If success is true, this parameter is empty.	""
data	array	The response data.
	Deployment	This data structure describes a complete deployed job.	"[main] INFO org.apache.flink.runtime.entrypoint.ClusterEntrypoint [] - --------------------------------------------------------------------------------\n2024-05-22 11:46:39,871 [main] INFO org.apache.flink.runtime.entrypoint.ClusterEntrypoint"

Examples

Success response

JSON format

{
  "requestId": "CBC799F0-AS7S-1D30-8A4F-882ED4DD****",
  "success": true,
  "httpCode": 200,
  "errorCode": "\"\"",
  "errorMessage": "\"\"",
  "data": [
    {
      "deploymentId": "00000000-0000-0000-0000-0000012312****",
      "namespace": "default-namespace",
      "name": "deploymentName",
      "engineVersion": "vvr-6.0.0-flink-1.15",
      "description": "this is a deployment description",
      "creator": "27846363877456****",
      "creatorName": "****@streamcompute.onaliyun.com",
      "modifier": "27846363877456****",
      "modifierName": "****@streamcompute.onaliyun.com",
      "deploymentHasChanged": true,
      "artifact": {
        "sqlArtifact": {
          "sqlScript": "CREATE TEMPORARY TABLE datagen_source(   name VARCHAR ) WITH (   'connector' = 'datagen' ); CREATE TEMPORARY TABLE blackhole_sink(   name  VARCHAR ) with (   'connector' = 'blackhole' ); INSERT INTO blackhole_sink SELECT name from datagen_source;",
          "additionalDependencies": [
            "https://oss/bucket/addition.jar"
          ]
        },
        "jarArtifact": {
          "jarUri": "https://oss/bucket/test.jar",
          "entryClass": "org.apapche.flink.test",
          "mainArgs": "start from main",
          "additionalDependencies": [
            "https://oss/bucket/addition.jar"
          ]
        },
        "pythonArtifact": {
          "pythonArtifactUri": "https://oss/bucket/test.py",
          "mainArgs": "start from main",
          "entryModule": "test.py",
          "additionalDependencies": [
            "https://oss/bucket/addition.py"
          ],
          "additionalPythonLibraries": [
            "https://oss/bucket/additionlib.py"
          ],
          "additionalPythonArchives": [
            "https://oss/bucket/additionArchives.zip"
          ]
        },
        "cdcYamlArtifact": {
          "cdcYaml": "",
          "additionalDependencies": [
            ""
          ]
        },
        "kind": "SQLSCRIPT"
      },
      "flinkConf": {
        "taskmanager.numberOfTaskSlots": "1"
      },
      "logging": {
        "loggingProfile": "default",
        "log4j2ConfigurationTemplate": "xml格式文本",
        "log4jLoggers": [
          {
            "loggerName": "StdOutErrConsoleAppender",
            "loggerLevel": "ERROR"
          }
        ],
        "logReservePolicy": {
          "openHistory": true,
          "expirationDays": 7
        }
      },
      "jobSummary": {
        "starting": 1,
        "running": 2,
        "cancelling": 0,
        "cancelled": 5,
        "finished": 4,
        "failed": 6
      },
      "deploymentTarget": {
        "mode": "PER_JOB",
        "name": "default-queue\t"
      },
      "executionMode": "STREAMING",
      "streamingResourceSetting": {
        "resourceSettingMode": "EXPERT",
        "expertResourceSetting": {
          "jobmanagerResourceSettingSpec": {
            "cpu": 2,
            "memory": "4 GiB"
          },
          "resourcePlan": "{\\\"ssgProfiles\\\":[{\\\"name\\\":\\\"default\\\",\\\"cpu\\\":1.13,\\\"heap\\\":\\\"1 gb\\\",\\\"offHeap\\\":\\\"32 mb\\\",\\\"managed\\\":{},\\\"extended\\\":{}}],\\\"nodes\\\":[{\\\"id\\\":1,\\\"type\\\":\\\"StreamExecTableSourceScan\\\",\\\"desc\\\":\\\"Source: datagen_source[78]\\\",\\\"profile\\\":{\\\"group\\\":\\\"default\\\",\\\"parallelism\\\":1,\\\"maxParallelism\\\":32768,\\\"minParallelism\\\":1}},{\\\"id\\\":2,\\\"type\\\":\\\"StreamExecSink\\\",\\\"desc\\\":\\\"Sink: blackhole_sink[79]\\\",\\\"profile\\\":{\\\"group\\\":\\\"default\\\",\\\"parallelism\\\":1,\\\"maxParallelism\\\":32768,\\\"minParallelism\\\":1}}],\\\"edges\\\":[{\\\"source\\\":1,\\\"target\\\":2,\\\"mode\\\":\\\"PIPELINED\\\",\\\"strategy\\\":\\\"FORWARD\\\"}],\\\"vertices\\\":{\\\"717c7b8afebbfb7137f6f0f99beb2a94\\\":[1,2]}}"
        },
        "basicResourceSetting": {
          "parallelism": 4,
          "jobmanagerResourceSettingSpec": {
            "cpu": 2,
            "memory": "4 GiB"
          },
          "taskmanagerResourceSettingSpec": {
            "cpu": 2,
            "memory": "4 GiB"
          }
        }
      },
      "batchResourceSetting": {
        "maxSlot": 10,
        "basicResourceSetting": {
          "parallelism": 4
        }
      },
      "labels": {
        "test": "test",
        "test2": 1
      },
      "localVariables": [
        {
          "name": "test",
          "value": "datagen"
        }
      ],
      "workspace": "edcef******b4f",
      "createdAt": "1714058507\n",
      "modifiedAt": "1714058843",
      "referencedDeploymentDraftId": "00000000-0000-0000-0000-000000000003"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.