All Products
Search
Document Center

Realtime Compute for Apache Flink:ListDeploymentTargets

Last Updated:Mar 31, 2026

Obtains a list of clusters in which deployments can be deployed. The cluster can be a session cluster or a per-job cluster.

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

list

*All Resource

*

None None

Request syntax

GET /api/v2/namespaces/{namespace}/deployment-targets 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 workspace ID.

a14bd5d90a****

pageSize

integer

No

The number of entries per page. Valid values: 1 to 100. Default value: 10.

10

pageIndex

integer

No

The page number. Minimum value: 1. Default value: 1.

1

Response elements

Element

Type

Description

Example

object

The response parameters.

requestId

string

The request ID.

CBC799F0-AS7S-1D30-8A4F-882ED4DD****

success

boolean

Indicates whether the request was successful.

true

httpCode

integer

The value was fixed to 200.

200

errorCode

string

  • If the value of success was false, an error code was returned.

  • If the value of success was true, a null value was returned.

""

errorMessage

string

  • If the value of success was false, an error message was returned.

  • If the value of success was true, a null value was returned.

""

pageSize

integer

The number of entries per page.

10

pageIndex

integer

The page number.

1

totalSize

integer

The total number of entries returned.

1

data

array

  • If the value of success was true, a list of clusters in which the deployment is deployed was returned.

  • If the value of success was false, a null value was returned.

DeploymentTarget

The information about the cluster in which the deployment is deployed

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.