All Products
Search
Document Center

DataWorks:ListEnabledExtensionsForProject

Last Updated:Nov 21, 2024

Queries a list of built-in and custom extensions that are enabled in a workspace.

Operation description

For information about codes of extension point events, see Development references: Extension point event codes.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
EventCodestringYes

The code of the extension point event.

commit-file
ProjectIdlongYes

The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to obtain the workspace ID.

10000
FileTypestringNo

The type of the code for the file.

Valid values: 6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 24 (ODPS Script), 99 (zero load), 221 (PyODPS 2), 225 (ODPS Spark), 227 (EMR Hive), 228 (EMR Spark), 229 (EMR Spark SQL), 230 (EMR MR), 239 (OSS object inspection), 257 (EMR Shell), 258 (EMR Spark Shell), 259 (EMR Presto), 260 (EMR Impala), 900 (real-time synchronization), 1089 (cross-tenant collaboration), 1091 (Hologres development), 1093 (Hologres SQL), 1100 (assignment), and 1221 (PyODPS 3).

You can call the ListFileType operation to query the type of the code for the file.

10

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

4F2CA7ED-27E5-59EA-A8C4-F1F7A1FF0B22
Extensionsarray<object>

The details of the extension.

Extensionsobject
ExtensionCodestring

The unique code of the extension.

a94a8e23bc0b4dfab9a5e4d2f374d645
ExtensionNamestring

The name of the extension.

TenantIdlong

The tenant ID.

529889518659842
CreateUserstring

The creator of the extension.

3444434343555
ModifyUserstring

The modifier of the extension.

34452335611988
ExtensionDescstring

The description of the extension.

Ownerstring

The owner ID.

21323672*******55500
ParameterSettingstring

The parameter settings of the extension. For more information, see Configure extension parameters.

extension.fileType.23.deploy-file.enabled=true

Examples

Sample success responses

JSONformat

{
  "RequestId": "4F2CA7ED-27E5-59EA-A8C4-F1F7A1FF0B22",
  "Extensions": [
    {
      "ExtensionCode": "a94a8e23bc0b4dfab9a5e4d2f374d645",
      "ExtensionName": "",
      "TenantId": 529889518659842,
      "CreateUser": "3444434343555",
      "ModifyUser": "34452335611988",
      "ExtensionDesc": "",
      "Owner": "21323672*******55500",
      "ParameterSetting": "extension.fileType.23.deploy-file.enabled=true"
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-12-11The response structure of the API has changedView Change Details