文档

GetExtension - 获取扩展程序详情

更新时间:

获取某个扩展程序详情。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dataworks:*Read
  • 全部资源
    *

请求参数

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

扩展程序唯一编码。

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

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

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

0000-ABCD-EFG
Extensionobject

扩展程序详情。

ExtensionCodestring

扩展程序唯一码。

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

扩展程序名称。

扩展程序名称
ExtensionDescstring

扩展程序描述。

这是一个描述
HelpDocUrlstring

扩展程序帮助文档链接。

https://www.aliyun.com/
Statusinteger

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

0
ProjectTestinglong

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

13552
DetailUrlstring

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

https://www.aliyun.com/
ParameterSettingstring

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

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

选项配置。

选项配置
BindEventListobject []

扩展点列表。

EventCodestring

扩展点事件编码。

commit-file
EventNamestring

扩展点事件名称。

文件提交前置事件
EventCategoryListobject []

事件类型列表。

CategoryCodestring

事件类型编码。

file-change
CategoryNamestring

事件类型名称。

文件变更事件

示例

正常返回示例

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

错误码

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

  • 本页导读 (1)