All Products
Search
Document Center

DataWorks:GetExtension

Last Updated:Nov 21, 2024

Queries the details of an extension.

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
ExtensionCodestringYes

The unique code of the extension.

ce4*********086da5

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID. You can use the request ID to query logs and troubleshoot issues.

0000-ABCD-EFG
Extensionobject

The details of the extension.

ExtensionCodestring

The unique code of the extension.

ce4*********086da5
ExtensionNamestring

The name of the extension.

ExtensionDescstring

The description of the extension.

HelpDocUrlstring

The URL of the help documentation of the extension.

https://www.aliyun.com/
Statusinteger

The state of the extension. 0: Testing, 1: Publishing, 3: Disabled, 4: Processing, 5: Approved, 6: Approve Failed

0
ProjectTestinglong

The workspace for testing. If the extension is being tested, the extension can be used only in the workspace for testing.

13552
DetailUrlstring

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/
ParameterSettingstring

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

extension.project.disabled=projectId1,projectId2,projectId3
OptionSettingstring

The options defined for the extension.

BindEventListarray<object>

The list of extension points.

BindEventListobject
EventCodestring

The code of the extension point event.

commit-file
EventNamestring

The name of the extension point event.

EventCategoryListarray<object>

The list of event types.

EventCategoryListobject
CategoryCodestring

The code of the event type.

file-change
CategoryNamestring

The name of the event type.

Examples

Sample success responses

JSONformat

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

Error codes

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