全部产品
Search
文档中心

大数据开发治理平台 DataWorks:GetExtension - 获取扩展程序详情

更新时间:Jan 21, 2025

获取某个扩展程序详情。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
ExtensionCodestring

扩展程序唯一编码。

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

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求的 ID。用于定位日志,排查问题。

0000-ABCD-EFG
Extensionobject

扩展程序详情。

ExtensionCodestring

扩展程序唯一码。

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

扩展程序名称。

Extension name
ExtensionDescstring

扩展程序描述。

This is a description
HelpDocUrlstring

扩展程序帮助文档链接。

https://www.aliyun.com/
Statusinteger

扩展程序状态: 0:测试中, 1:上线中, 3:禁用中, 4:审批中, 5:审批通过, 6:审批不通过。

0
ProjectTestinglong

测试用的项目空间,当扩展程序处于测试中时,只有测试项目空间可使用。

1355211
DetailUrlstring

扩展程序详情地址,用来扩展程序使用者查看本次被卡流程的详情。

https://www.aliyun.com/
ParameterSettingstring

参数配置,参考扩展程序参数配置

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

选项配置。

Option configuration
BindEventListarray<object>

扩展点列表。

BindEventListobject

扩展点详情。

EventCodestring

扩展点事件编码。

commit-file
EventNamestring

扩展点事件名称。

File submission pre-event
EventCategoryListarray<object>

事件类型列表。

EventCategoryListobject

事件类型详情。

CategoryCodestring

事件类型编码。

file-change
CategoryNamestring

事件类型名称。

File change event

示例

正常返回示例

JSON格式

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

错误码

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