ListDeploymentDrafts API Reference for SQL Job Drafts - Realtime Compute for Apache Flink - Alibaba Cloud - Realtime Compute for Apache Flink

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

list

*All Resource

*

None

Request syntax

GET /api/v2/namespaces/{namespace}/deployment-drafts 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****
pageSize	integer	No	The number of entries to return on each page. The default value is 10. The maximum value is 100.	10
pageIndex	integer	No	The page number to return. The default value is 1.	1

Response elements

Element	Type	Description	Example
	object	The response.
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. If this parameter is not empty and its value is not 200, the request failed.	200
errorCode	string	If the request fails, the error code is returned. If the request is successful, this parameter is empty.	""
errorMessage	string	If the request fails, the error message is returned. If the request is successful, this parameter is empty.	""
pageIndex	integer	The page number of the returned page.	1
pageSize	integer	The number of entries on the returned page.	10
totalSize	integer	The total number of entries that match the query.	69
data	array	A list of job drafts that match the query. This parameter is returned if the request is successful. If the request fails, this parameter is empty.
	DeploymentDraft	The details of the job draft.

Examples

Success response

JSON format

{
  "requestId": "CBC799F0-AS7S-1D30-8A4F-882ED4DD****",
  "success": true,
  "httpCode": 200,
  "errorCode": "\"\"",
  "errorMessage": "\"\"",
  "pageIndex": 1,
  "pageSize": 10,
  "totalSize": 69,
  "data": [
    {
      "deploymentDraftId": "00000000-0000-0000-0000-00000012****",
      "name": "test-draft",
      "parentId": "00000000-0000-0000-0000-00000013****",
      "referencedDeploymentId": "00000000-0000-0000-0000-0000012312****",
      "executionMode": "STREAMING",
      "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"
      },
      "engineVersion": "vvr-6.0.7-flink-1.15",
      "localVariables": [
        {
          "name": "test",
          "value": "datagen"
        }
      ],
      "labels": {
        "test": "test",
        "test2": 1
      },
      "lock": {
        "id": "stt-fu1658tbk6mnkk2****",
        "workspace": "a14bd5d90a****",
        "namespace": "default-namespace",
        "holderId": "18389966****",
        "holderName": "userA"
      },
      "workspace": "edcef******b4f",
      "namespace": "default-namespace",
      "creator": "27846363877456****",
      "creatorName": "****@streamcompute.onaliyun.com",
      "modifier": "27846363877456****",
      "modifierName": "****@streamcompute.onaliyun.com",
      "createdAt": 1723537978,
      "modifiedAt": 1723537978
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.