Queries the details of an extension.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes GetExtension

The operation that you want to perform. Set the value to GetExtension.

RegionId String No cn-zhangjiakou

The ID of the region in which the DataWorks workspace resides. For example, the ID of the China (Shanghai) region is cn-shanghai, and that of the China (Zhangjiakou) region is cn-zhangjiakou. The system automatically determines the value of this parameter based on the endpoint that is used to call the operation.

ExtensionCode String Yes ce4*********086da5

The unique code of the extension.

Response parameters

Parameter Type Example Description
RequestId String 0000-ABCD-EFG

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

Extension Object

The details of the extension.
ExtensionCode String ce4*********086da5

The unique code of the extension.
ExtensionName String ExtensionName

The name of the extension.
ExtensionDesc String This is a description.

The description of the extension.
HelpDocUrl String https://www.aliyun.com/

The URL of the help document about the extension.
Status Integer 0

The state of the extension. 0: testing. 1: publishing. 3: disabled. 4: approving. 5: approved. 6: approval failed.

ProjectTesting Long 13552

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

DetailUrl String https://www.aliyun.com/

The URL of the help document about the extension. You can visit the URL for the details of the extension.

ParameterSetting String extension.project.disabled=projectId1,projectId2,projectId3

The parameter settings of the extension. For more information, visit https://www.alibabacloud.com/help/en/dataworks/latest/set-extension-parameters.
OptionSetting String OptionSetting

The option settings of the extension.
BindEventList Array of BindEventList

The extension point events.
EventCode String commit-file

The code of the extension point event.
EventName String File Commitment Event

The name of the extension point event.
EventCategoryList Array of EventCategoryList

The types of the events.
CategoryCode String file-change

The code of the event type.
CategoryName String File Change Event

The name of the event type.

Examples

Sample requests

http(s)://[Endpoint]/?Action=GetExtension
&ExtensionCode=ce4*********086da5
&Common request parameters

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<GetExtensionResponse>
    <RequestId>0000-ABCD-EFG</RequestId>
    <Extension>
        <ExtensionCode>ce4*********086da5</ExtensionCode>
        <ExtensionName>ExtensionName</ExtensionName>
        <ExtensionDesc>This a description.</ExtensionDesc>
        <HelpDocUrl>https://www.aliyun.com/</HelpDocUrl>
        <Status>0</Status>
        <ProjectTesting>13552</ProjectTesting>
        <DetailUrl>https://www.aliyun.com/</DetailUrl>
        <ParameterSetting>extension.project.disabled=projectId1,projectId2,projectId3</ParameterSetting>
        <OptionSetting>OptionSetting</OptionSetting>
        <BindEventList>
            <EventCode>commit-file</EventCode>
            <EventName>File Commitment Event</EventName>
        </BindEventList>
        <EventCategoryList>
            <CategoryCode>file-change</CategoryCode>
            <CategoryName>File Change Event</CategoryName>
        </EventCategoryList>
    </Extension>
</GetExtensionResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "0000-ABCD-EFG",
  "Extension" : {
    "ExtensionCode" : "ce4*********086da5",
    "ExtensionName" : "ExtensionName",
    "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" : "OptionSetting",
    "BindEventList" : {
      "EventCode" : "commit-file",
      "EventName" : "File Commitment Event"
    },
    "EventCategoryList" : {
      "CategoryCode" : "file-change",
      "CategoryName" : "File Change Event"
    }
  }
}

Error codes

For more information about error codes, visit API Error Center.