Queries the extensions of DataWorks Open Platform.

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 ListExtensions

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

RegionId String No cn-shanghai

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 determines the value of this parameter based on the endpoint that is used to call the operation.

PageNumber Integer No 1

The number of the page to return.

PageSize Integer No 10

The number of entries to return on each page.

Response parameters

Parameter Type Example Description
RequestId String 0000-ABCD-EFG

Id of the request
PagingInfo Object

The extensions returned on pages.
PageNumber Integer 1

The page number of the returned page.

PageSize Integer 10

The number of entries returned per page.
TotalCount Integer 12

The total number of entries returned.

Extensions Array of Extensions

The extensions.
Status Integer 0

The state of the extension. Valid values:

0: Testing

1: Publishing

3: Disabled

4: Processing

5: Approved

6: Approve Failed
ExtensionDesc String This is a description.

The description of the extension.
ExtensionName String ExtensionName

The name of the extension.
Owner String 2003****

The ID of the RAM user.
ExtensionCode String ExtensionCode

The unique code of the extension.
BindEventList Array of BindEventList

The extension point events.
EventName String File Commitment Event

The name of the event.
EventCode String commit-file

The code of the event.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListExtensions
&PageNumber=1
&PageSize=10
&Common request parameters

Sample success responses

XML format 

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

<ListExtensionsResponse>
    <RequestId>0000-ABCD-EFG</RequestId>
    <PagingInfo>
        <PageNumber>1</PageNumber>
        <PageSize>10</PageSize>
        <TotalCount>12</TotalCount>
        <Extensions>
            <Status>0</Status>
            <ExtensionDesc>This is a description.</ExtensionDesc>
            <ExtensionName>ExtensionName</ExtensionName>
            <Owner>2003****</Owner>
            <ExtensionCode>ExtensionCode</ExtensionCode>
            <BindEventList>
                <EventName>File Commitment Event</EventName>
                <EventCode>commit-file</EventCode>
            </BindEventList>
        </Extensions>
    </PagingInfo>
</ListExtensionsResponse>

JSON format 

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

{
  "RequestId" : "0000-ABCD-EFG",
  "PagingInfo" : {
    "PageNumber" : 1,
    "PageSize" : 10,
    "TotalCount" : 12,
    "Extensions" : [ {
      "Status" : 0,
      "ExtensionDesc" : "This is a description.",
      "ExtensionName" : "ExtensionName",
      "Owner" : "2003****",
      "ExtensionCode" : "ExtensionCode",
      "BindEventList" : [ {
        "EventName" : "File Commitment Event",
        "EventCode" : "commit-file"
      } ]
    } ]
  }
}

Error codes

For a list of error codes, visit the API Error Center.