Query extension details with GetExtension - DataWorks - Alibaba Cloud - DataWorks

Retrieves the details of an extension.

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 parameters

Parameter	Type	Required	Description	Example
ExtensionCode	string	Yes	The unique code of the extension.	ce4*********086da5

Response elements

Element	Type	Description	Example
	object	The returned result.
RequestId	string	The request ID. You can use the request ID to query logs and troubleshoot issues.	0000-ABCD-EFG
Extension	object	The details of the extension.
ExtensionCode	string	The unique code of the extension.	ce4*********086da5
ExtensionName	string	The name of the extension.	Extension name
ExtensionDesc	string	The description of the extension.	This is a description
HelpDocUrl	string	The URL of the help documentation of the extension.	https://www.aliyun.com/
Status	integer	The state of the extension. 0: Testing, 1: Publishing, 3: Disabled, 4: Processing, 5: Approved, 6: Approve Failed	0
ProjectTesting	integer	The workspace for testing. If the extension is being tested, the extension can be used only in the workspace for testing.	13552
DetailUrl	string	The URL of the extension details page, on which users can view the details of the process blocked by the extension.	https://www.aliyun.com/
ParameterSetting	string	The parameter settings of the extension. For more information, see Configure extension parameters.	extension.project.disabled=projectId1,projectId2,projectId3
OptionSetting	string	The options defined for the extension.	Option configuration
BindEventList	array<object>	The list of extension points.
	object	The details of the extension point.
EventCode	string	The code of the extension point event.	commit-file
EventName	string	The name of the extension point event.	File submission pre-event
EventCategoryList	array<object>	The list of event types.
	object	The details of the event type.
CategoryCode	string	The code of the event type.	file-change
CategoryName	string	The name of the event type.	File change event

Examples

Success response

JSON format

{
  "RequestId": "0000-ABCD-EFG",
  "Extension": {
    "ExtensionCode": "ce4*********086da5",
    "ExtensionName": "Extension name",
    "ExtensionDesc": "This is a description",
    "HelpDocUrl": "https://www.aliyun.com/",
    "Status": 0,
    "ProjectTesting": 13552,
    "DetailUrl": "https://www.aliyun.com/",
    "ParameterSetting": "extension.project.disabled=projectId1,projectId2,projectId3",
    "OptionSetting": "Option configuration",
    "BindEventList": [
      {
        "EventCode": "commit-file",
        "EventName": "File submission pre-event"
      }
    ],
    "EventCategoryList": [
      {
        "CategoryCode": "file-change",
        "CategoryName": "File change event"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.