GetExtension - 大数据开发治理平台 DataWorks

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	GetExtension	系统规定参数。取值：GetExtension。
RegionId	String	否	cn-zhangjiakou	地域信息，通常为服务所在的地域。例如，华东2（上海）为cn-shanghai，华北3（张家口）为cn-zhangjiakou。您无需填写RegionId，会根据调用的Endpoint自动解析。
ExtensionCode	String	是	ce4*********086da5	扩展程序唯一编码。

返回数据


名称	类型	示例值	描述
RequestId	String	0000-ABCD-EFG	请求的ID。用于定位日志，排查问题。
Extension	Object		扩展程序详情。
ExtensionCode	String	ce4*********086da5	扩展程序唯一码。
ExtensionName	String	扩展程序名称	扩展程序名称。
ExtensionDesc	String	这是一个描述	扩展程序描述。
HelpDocUrl	String	https://www.aliyun.com/	扩展程序帮助文档链接。
Status	Integer	0	扩展程序状态： 0：测试中, 1：上线中, 3：禁用中, 4：审批中, 5：审批通过, 6：审批不通过。
ProjectTesting	Long	13552	测试用的项目空间，当扩展程序处于测试中时，只有测试项目空间可使用。
DetailUrl	String	https://www.aliyun.com/	扩展程序详情地址，用来扩展程序使用者查看本次被卡流程的详情。
ParameterSetting	String	extension.project.disabled=projectId1,projectId2,projectId3	参数配置，参考扩展程序参数配置。
OptionSetting	String	选项配置	选项配置。
BindEventList	Array of BindEventList		扩展点列表。
EventCode	String	commit-file	扩展点事件编码。
EventName	String	文件提交前置事件	扩展点事件名称。
EventCategoryList	Array of EventCategoryList		事件类型列表。
CategoryCode	String	file-change	事件类型编码。
CategoryName	String	文件变更事件	事件类型名称。

示例

请求示例

http(s)://[Endpoint]/?Action=GetExtension
&ExtensionCode=ce4*********086da5
&公共请求参数

正常返回示例

XML格式

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

<GetExtensionResponse>
    <RequestId>0000-ABCD-EFG</RequestId>
    <Extension>
        <ExtensionCode>ce4*********086da5</ExtensionCode>
        <ExtensionName>扩展程序名称</ExtensionName>
        <ExtensionDesc>这是一个描述</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>
        <BindEventList>
            <EventCode>commit-file</EventCode>
            <EventName>文件提交前置事件</EventName>
        </BindEventList>
        <EventCategoryList>
            <CategoryCode>file-change</CategoryCode>
            <CategoryName>文件变更事件</CategoryName>
        </EventCategoryList>
    </Extension>
</GetExtensionResponse>

JSON格式

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

{
  "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" : "文件变更事件"
    }
  }
}

错误码

访问错误中心查看更多错误码。