本文为您介绍DataWorks OpenAPI的可用范围、计费方式和调用限制。

版本与地域要求

  • 版本要求:
    DataWorks为您提供不同功能模块的OpenAPI,如租户、元数据、数据开发、运维中心等功能模块。各功能模块的OpenAPI对DataWorks的版本要求与功能本身对DataWorks版本的要求一致。
    • 各版本的OpenAPI有相应的调用限制,详情请参见调用限制
    • 各版本的OpenAPI分别提供相应的每月免费调用额度,超过之后则需按量付费,可免费调用的额度及后续按量计费的详情请参见免费额度与计费方式
    • 各个OpenAPI对应的版本,请参见OpenAPI列表
  • 可用地域:

    华东1(杭州)、华东2(上海)、华南1(深圳)、华北2(北京)、华北3(张家口)、北京政务云、华东2(上海)金融云、西南1(成都)、中国(香港)、亚太东南1(新加坡)、印度尼西亚(雅加达)、美国(硅谷)、印度(孟买)、美国(弗吉尼亚)和德国(法兰克福)、英国(伦敦)、日本(东京)、澳大利亚(悉尼)、马来西亚(吉隆坡) 。

调用限制

为规范DataWorks OpenAPI的调用,保障系统稳定性,将OpenAPI分为1级、2级和3级,详情请参见OpenAPI列表。不同版本和不同分级的OpenAPI分别有相应的QPS限制和每日调用次数限制,具体如下。
说明 查看OpenAPI免费额度、调用次数、调用明细等详情请参见查看OpenAPI使用情况
版本QPS限制每日调用次数上限
基础版1级、2级、3级API总QPS≤5每日API总调用次数≤100次
标准版每日API总调用次数≤1000次
专业版每日API总调用次数≤10000次
企业版
  • 1级API QPS≤50
  • 2级API QPS≤20
  • 3级API QPS≤5
  • 1级、2级API 每日API总调用次数不限
  • 3级API 每日API总调用次数≤10000次
重要
  • API QPS和调用次数的统计口径:每个主账号及其子账号在每个地域的累计值。
  • 当超过QPS或每日调用次数限制后,将会出现调用失败,请合理控制调用并发和次数。
  • API调用成功和调用失败的次数都会计入每日调用限制次数中。

免费额度与计费方式

OpenAPI采用版本结合按量计费的商业化方式,计费标准如下。
版本免费调用额度超出免费调用额度后按量计费
基础版3100次/月有调用限制,不支持额外按量付费。
标准版31000次/月
专业版310000次/月
企业版1000000次/月0.05美元/万次
重要
  • 每个自然月会给与每个主账号(包含子账号)在每个地域的OpenAPI一定的免费调用额度,不同版本的DataWorks每月可用的免费额度不一样。
  • 受不同版本DataWorks日调用次数限制(详情见调用限制),基础版、标准版、专业版的每月实际可调用量可能无法超过免费调用额度,且不支持按量付费。
  • DataWorks企业版免费额度用尽后,支持根据按量计费的价格进行收费,实际计费价格以最终账单显示的价格为准。
  • 只有当API调用成功后,才会消耗免费调用额度并且在超过免费调用额度后按量计费,API调用失败的话不会消耗免费调用额度且不计量计费。

OpenAPI列表

DataWorks OpenAPI包括租户、元数据、数据开发、数据集成、数据建模、运维中心、数据质量、数据服务、数据保护伞、迁移助手及安全中心。

租户

API名称API描述API级别最低版本要求

(本版本及以上版本支持)

ListCalcEngines调用ListCalcEngines查看计算引擎列表。2级基础版
CreateDataSource调用CreateDataSource接口,创建DataWorks数据源。2级
ListDataSources调用ListDataSources接口,查询DataWorks数据源列表。3级
UpdateDataSource调用UpdateDataSource接口,更新数据源。2级
DeleteDataSource调用DeleteDataSource接口,删除一个数据源。2级
ListResourceGroups调用ListResourceGroups查看资源组列表。1级
GetProject调用GetProject查询一个DataWorks工作空间的信息。1级
AddProjectMemberToRole调用AddProjectMemberToRole,添加DataWorks工作空间用户至角色。用户需要先添加至DataWorks工作空间内。2级
CreateProjectMember调用CreateProjectMember,添加一个用户至DataWorks工作空间。2级
DeleteProjectMember调用DeleteProjectMember,从DataWorks工作空间移除用户。2级
ListProjectRoles调用ListProjectRoles获取工作空间所有角色的列表。1级
RemoveProjectMemberFromRole调用RemoveProjectMemberFromRole,将DataWorks工作空间内的用户从DataWorks角色中移除。2级
ListProjectMembers调用ListProjectMembers查询DataWorks工作空间中已存在成员的列表。1级
ListProjects调用ListProjects,分页列出用户所在租户下的DataWorks工作空间列表。1级
ListProjectIds调用ListProjectIds,使用目标阿里云账号(包括阿里云主账号或RAM用户)的ID获取其拥有角色权限的DataWorks工作空间的ID列表。1级
DeleteProject调用DeleteProject接口,删除DataWorks工作空间。3级
CreateProject调用CreateProject接口,创建 DataWorks 工作空间。3级
UpdateProject调用UpdateProject接口,更新DataWorks工作空间。3级
ChangeResourceManagerResourceGroup调用ChangeResourceManagerResourceGroup接口,修改资源归属资源组。3级

元数据

API名称API描述API级别最低版本要求

(本版本及以上版本支持)

GetMetaDBInfo调用GetMetaDBInfo获取引擎实例的基本元数据信息。1级基础版
GetMetaDBTableList调用GetMetaDBTableList获取引擎实例下的表。1级基础版
CheckMetaTable调用CheckMetaTable检查表是否存在。1级基础版
CheckMetaPartition调用CheckMetaPartition检查分区是否存在。1级基础版
SearchMetaTables调用SearchMetaTables根据条件搜索表。1级基础版
GetMetaTableBasicInfo调用GetMetaTableBasicInfo获取表的基础信息。1级基础版
GetMetaTableColumn调用GetMetaTableColumn获取表的字段信息。1级基础版
GetMetaTablePartition调用GetMetaTablePartition获取表的分区列表。1级基础版
GetMetaTableOutput调用GetMetaTableOutput获取表的产出信息。1级基础版
GetMetaTableChangeLog调用GetMetaTableChangeLog获取表的变更日志。1级基础版
GetMetaTableIntroWiki调用GetMetaTableIntroWiki获取表的使用说明。1级基础版
GetMetaTableLineage调用GetMetaTableLineage获取表的血缘关系。1级标准版
GetMetaColumnLineage调用GetMetaColumnLineage获取字段的血缘关系。2级标准版
CreateMetaCategory调用CreateMetaCategory创建类目。2级基础版
DeleteMetaCategory调用DeleteMetaCategory删除类目。2级基础版
UpdateMetaCategory调用UpdateMetaCategory更新类目。2级基础版
GetMetaCategory调用GetMetaCategory查询类目树。1级基础版
GetMetaTableListByCategory调用GetMetaTableListByCategory查询指定类目下的表。1级基础版
AddToMetaCategory调用AddToMetaCategory添加表至指定的类目。2级基础版
DeleteFromMetaCategory调用DeleteFromMetaCategory从指定的类目中移除表。2级基础版
CreateTable调用CreateTable创建一个MaxCompute表。3级企业版
UpdateTable调用UpdateTable更新MaxCompute表。2级企业版
UpdateTableAddColumn调用UpdateTableAddColumn更新MaxCompute表的字段信息。3级企业版
DeleteTable调用DeleteTable删除MaxCompute表。2级企业版
GetDDLJobStatus调用GetDDLJobStatus获取创建表、更新表和删除表的任务状态。1级企业版
UpdateMetaTable调用UpdateMetaTable更新表的Meta信息。2级企业版
UpdateMetaTableIntroWiki调用UpdateMetaTableIntroWiki更新表的说明信息,当数据不存在时增加信息。2级基础版
ListMetaDB调用ListMetaDB查询数据库列表。1级基础版
UpdateTableModelInfo调用UpdateTableModelInfo修改表的主题、层级和物理分类等信息。2级企业版
CreateTableTheme调用CreateTableTheme创建主题。2级基础版
DeleteTableTheme调用DeleteTableTheme删除主题。2级基础版
UpdateTableTheme 调用UpdateTableTheme更新主题。2级基础版
ListTableTheme调用ListTableTheme查询主题列表。1级基础版
CreateTableLevel调用CreateTableLevel创建层级。2级基础版
DeleteTableLevel调用DeleteTableLevel删除层级。2级基础版
UpdateTableLevel调用UpdateTableLevel更新层级。2级基础版
ListTableLevel调用ListTableLevel查询层级列表。1级基础版
GetMetaTableThemeLevel调用GetMetaTableThemeLevel获取表的主题和层级关系。1级专业版
UpdateMetaCollection调用UpdateMetaCollection更新集合对象。2级专业版
ListMetaCollections调用ListMetaCollections查询集合信息。2级专业版
ListMetaCollectionEntities调用ListMetaCollectionEntities查询集合中的实体。2级专业版
DeleteMetaCollection调用DeleteMetaCollection删除集合。2级专业版
GetMetaCollectionDetail调用GetMetaCollectionDetail查询集合详情信息。2级专业版
DeleteMetaCollectionEntity调用DeleteMetaCollectionEntity删除集合中的实体。2级专业版
AddMetaCollectionEntity调用AddMetaCollectionEntity添加实体到集合中。2级专业版
CreateMetaCollection调用CreateMetaCollection创建集合对象。2级专业版
GetMetaTableProducingTasks调用GetMetaTableProducingTasks查询表的产出任务列表。1级专业版

数据开发

API名称API描述API级别最低版本要求

(本版本及以上版本支持)

CreateFile调用CreateFile,在数据开发中创建一个文件。3级基础版
CreateUdfFile调用CreateUdfFile,在数据开发中创建函数类型文件。2级基础版
CreateBusiness调用CreateBusiness创建业务流程。2级基础版
DeleteBusiness调用DeleteBusiness删除业务流程。3级基础版
CreateFolder调用CreateFolder创建文件夹。2级基础版
UpdateBusiness调用UpdateBusiness更新业务流程。2级基础版
ListFiles调用ListFiles查询文件列表。1级基础版
EstablishRelationTableToBusiness调用EstablishRelationTableToBusiness,导入表至业务流程。相当于在数据开发页面右键单击业务流程,选择导入表的操作。2级基础版
SubmitFile调用SubmitFile,提交文件至调度系统的开发环境,生成对应的任务。3级基础版
ListBusiness调用ListBusiness查询业务流程的列表。1级基础版
GetFileVersion调用GetFileVersion获取文件的版本详情。1级基础版
DeleteFolder调用DeleteFolder删除数据开发页面的文件夹。3级基础版
DeleteFile调用DeleteFile删除数据开发中的文件。3级基础版
GetDeployment调用GetDeployment获取发布包的详情。1级基础版
UpdateFile调用UpdateFile更新文件。2级基础版
GetFolder调用GetFolder获取文件夹的详情。1级基础版
ListFileVersions调用ListFileVersions查询文件的版本列表。1级基础版
GetFile调用GetFile获取文件的详情。1级基础版
ListFolders调用ListFolders查询文件夹的列表。1级基础版
DeployFile调用DeployFile部署文件,发布文件至生产环境。3级基础版
UpdateUdfFile调用UpdateUdfFile更新函数的文件信息。2级基础版
GetBusiness调用GetBusiness查询业务流程的详情。1级基础版
UpdateFolder调用UpdateFolder更新文件夹的信息。2级基础版
ListDeployments调用ListDeployments,查询发布包列表信息。该功能与DataWorks控制台任务发布页面的发布包列表功能对应。1级基础版
UpdateIDEEventResult用于在数据开发过程中触发扩展点时,通过调用UpdateIDEEventResult接口,将扩展程序对扩展点事件的检查结果返回给DataWorks的数据开发系统。2级企业版
GetIDEEventDetail调用GetIDEEventDetail,根据DataWorks开放消息的消息ID,查询触发扩展点事件时的扩展点数据快照。1级企业版

数据集成

API名称API描述API级别最低版本要求

(本版本及以上版本支持)

CreateDISyncTask调用CreateDISyncTask创建数据集成同步任务。3级基础版
DeleteDISyncTask调用DeleteDISyncTask接口,删除数据集成同步任务。当前仅支持使用该接口删除实时数据同步任务。3级基础版
UpdateDISyncTask调用UpdateDISyncTask更新数据集成同步任务。3级基础版
TestNetworkConnection调用TestNetworkConnection接口,测试目标数据源与所使用资源组的网络连通性。3级基础版
GetDataSourceMeta调用GetDataSourceMeta获取目标数据源的Meta信息。3级基础版
ListDIProjectConfig调用ListDIProjectConfig查看当前工作空间中数据集成同步解决方案任务默认的全局配置。3级基础版
UpdateDIProjectConfig调用UpdateDIProjectConfig修改当前工作空间中数据集成同步解决方案任务默认的全局配置。3级基础版
GetDISyncTask调用GetDISyncTask获取数据集成实时同步任务和同步解决方案的详情。3级基础版
DeployDISyncTask调用DeployDISyncTask发布实时同步任务和同步解决方案任务。3级基础版
GetDISyncInstanceInfo调用GetDISyncInstanceInfo获取实时同步任务和同步解决方案任务的运行状态。3级基础版
StartDISyncInstance调用StartDISyncInstance接口,启动实时同步任务和解决方案同步任务。3级基础版
StopDISyncInstance调用StopDISyncInstance接口,停止实时同步任务。3级基础版
TerminateDISyncInstance调用TerminateDISyncInstance下线数据集成实时同步任务。3级基础版
GenerateDISyncTaskConfigForCreating调用GenerateDISyncTaskConfigForCreating接口,异步生成创建数据集成同步任务的异步线程ID。3级基础版
GenerateDISyncTaskConfigForUpdating调用GenerateDISyncTaskConfigForUpdating接口,异步生成更新数据集成同步任务的异步线程ID。3级基础版
QueryDISyncTaskConfigProcessResult调用QueryDISyncTaskConfigProcessResult接口,通过异步线程ID,获取异步生成或更新数据集成同步任务需要的参数。3级基础版

数据集成使用API创建数据集成任务,详情请参见最佳实践:创建离线同步任务OpenAPI基础实践

运维中心

API名称API描述API级别最低版本要求

(本版本及以上版本支持)

ListAlertMessages调用ListAlertMessages获取报警信息的列表。1级专业版
GetBaselineConfig调用GetBaselineConfig获取配置详情。1级专业版
ListNodesByBaseline调用ListNodesByBaseline获取基线中的节点。1级标准版
ListBaselineConfigs调用ListBaselineConfigs获取基线列表。1级标准版
GetBaselineKeyPath调用GetBaselineKeyPath获取基线实例的关键路径。1级标准版
GetBaselineStatus调用GetBaselineStatus获取基线实例的详情。1级标准版
ListBaselineStatuses调用ListBaselineStatuses获取基线实例列表。1级标准版
DeleteRemind调用DeleteRemind删除自定义监控报警规则。2级基础版
UpdateRemind调用UpdateRemind更新自定义报警规则。3级基础版
CreateRemind调用CreateRemind创建自定义报警规则。3级基础版
GetRemind调用GetRemind获取自定义监控报警规则的详情。1级基础版
ListReminds调用ListReminds获取或搜索自定义监控规则列表。1级基础版
ListTopics调用ListTopics获取或搜索事件列表。1级标准版
GetTopic调用GetTopic获取事件的详情。1级标准版
GetTopicInfluence调用GetTopicInfluence获取事件影响的基线实例列表。1级标准版
GetNode调用GetNode获取节点的详情。1级基础版
ListNodeInputOrOutput调用ListNodeInputOrOutput查询当前节点的上下游节点信息。该API只能查询上游或下游的一层节点信息。1级基础版
ListNodes调用ListNodes获取节点的列表。1级基础版
GetNodeCode调用GetNodeCode获取节点的代码。1级基础版
GetInstance调用GetInstance获取实例的详情。1级基础版
ListInstances调用ListInstances获取实例的列表。1级基础版
GetInstanceLog调用GetInstanceLog获取实例的日志。1级基础版
StopInstance调用StopInstance终止实例。2级基础版
RestartInstance调用RestartInstance重启实例。2级基础版
SetSuccessInstance调用SetSuccessInstance,重置失败状态的实例为成功。2级基础版
SuspendInstance调用SuspendInstance暂停实例。2级基础版
ResumeInstance调用ResumeInstance恢复暂停状态的实例。2级基础版
RunCycleDagNodes调用RunCycleDagNodes创建补数据工作流。2级基础版
RunSmokeTest调用RunSmokeTest创建冒烟测试工作流。2级基础版
ListSuccessInstanceAmount调用ListSuccessInstanceAmount,获取业务日期当天生成的周期实例任务,在业务日期的不同整点时刻,运行成功的实例数量统计趋势。3级基础版
ListInstanceAmount调用ListInstanceAmount获取指定时间段周期实例数量的趋势。1级基础版
TopTenElapsedTimeInstance调用TopTenElapsedTimeInstance获取实例运行时长排行。1级基础版
TopTenErrorTimesInstance调用TopTenErrorTimesInstance获取近一个月节点的出错排行。1级基础版
GetFileTypeStatistic调用GetFileTypeStatistic获取节点任务类型的分布情况。1级基础版
GetInstanceStatusStatistic调用GetInstanceStatusCount获取实例任务不同运行状态的数量统计。1级基础版
ListFileType调用ListFileType查询任务节点的类型信息,包括类型Code和类型名称。1级基础版
RunManualDagNodes调用RunManualDagNodes触发手动业务流程执行。手动业务流程必须已经在界面提交发布,运维中心能够找到对应的手动业务流程,才能使用该接口。2级基础版
ListManualDagInstances调用ListManualDagInstances获取手动执行的业务流程实例的信息。1级基础版
GetDag调用GetDag,根据DagId获取Dag详情。1级基础版
ListDags根据OpSeq获取单次补数据的所有Dag详情。1级基础版
ListNodesByOutput调用ListNodesByOutput根据节点的输出结果精确查询目标节点。1级基础版
RunTriggerNode调用RunTriggerNode运行一个触发式节点。2级基础版
GetNodeParents调用GetNodeParents获取节点上游列表。2级基础版
GetNodeChildren调用GetNodeChildren获取节点下游列表。2级基础版
UpdateNodeRunMode调用UpdateNodeRunMode冻结或解冻目标节点。2级基础版
UpdateNodeOwner调用UpdateNodeOwner修改目标节点的负责人。2级基础版
UpdateWorkbenchEventResult所属扩展程序的运维中心回调API,当运维中心的流程被扩展程序卡住后,调用UpdateWorkbenchEventResult返回扩展程序的处理结果。2级基础版
ListShiftPersonnels调用ListShiftPersonnels获取值班表的值班人员列表。1级基础版
ListShiftSchedules调用ListShiftSchedules获取运维中心值班表列表。1级基础版
ListInstanceHistory调用ListInstanceHistory,获取所有实例历史记录,任务重跑一次就会生成一条历史记录。1级基础版
ListInnerNodes调用ListInnerNodes获取内部节点详情,例如查询组合节点、循环节点等节点类型的内部节点,不支持PAI节点的内部节点查询。1级基础版
OfflineNode调用OfflineNode下线节点。3级基础版
CreateBaseline调用CreateBaseline创建基线。3级标准版
UpdateBaseline调用UpdateBaseline修改基线配置。3级标准版
GetBaseline调用GetBaseline根据基线id获取基线配置。1级标准版
ListBaselines调用ListBaselines获取基线配置列表。1级标准版
DeleteBaseline调用DeleteBaseline根据基线id删除基线配置。2级标准版

数据质量

API名称API描述API级别最低版本要求

(本版本及以上版本支持)

UpdateQualityFollower调用UpdateQualityFollower更新订阅关系。2级基础版
UpdateQualityRule调用UpdateQualityRule更新规则。2级
GetQualityRule调用GetQualityRule获取规则的信息。1级
ListQualityRules调用ListQualityRules根据分区表达式获取规则列表。3级
CreateQualityRule调用CreateQualityRule创建质量监控规则。3级
DeleteQualityFollower调用DeleteQualityFollower删除分区表达式的订阅人。2级
DeleteQualityRule调用DeleteQualityRule删除规则。2级
GetQualityFollower调用GetQualityFollower获取分区表达式的订阅人。1级
CreateQualityFollower调用CreateQualityFollower创建分区表达式的订阅人。3级
DeleteQualityEntity调用DeleteQualityEntity删除分区表达式。2级
GetQualityEntity调用GetQualityEntity获取分区表达式。1级
CreateQualityEntity调用CreateQualityEntity创建数据质量的分区表达式。2级
CreateQualityRelativeNode调用CreateQualityRelativeNode创建分区表达式关联。3级
DeleteQualityRelativeNode调用DeleteQualityRelativeNode删除调度关联。2级
ListQualityResultsByEntity调用ListQualityResultsByEntity,根据分区表达式查询校验历史结果。1级
ListQualityResultsByRule调用ListQualityResultsByRule,根据规则查询校验结果。1级

数据服务

API名称API描述API级别最低版本要求

(本版本及以上版本支持)

CreateDataServiceApi调用CreateDataServiceApi创建数据服务API。3级基础版
PublishDataServiceApi调用PublishDataServiceApi发布数据服务API。3级
DeleteDataServiceApi调用DeleteDataServiceApi删除数据服务API。3级
ListDataServiceApis调用ListDataServiceApis获取数据服务API开发中的信息列表。1级
GetDataServiceApi调用GetDataServiceApi查询数据服务API开发态的详情。1级
UpdateDataServiceApi调用UpdateDataServiceApi更新数据服务API开发态的信息。3级
GetDataServicePublishedApi调用GetDataServicePublishedApi查询数据服务API的发布态信息。1级
ListDataServicePublishedApis调用ListDataServicePublishedApis获取数据服务API的发布态信息列表。1级
ListDataServiceApiAuthorities调用ListDataServiceApiAuthorities获取授权给他人的API列表。1级
ListDataServiceAuthorizedApis调用ListDataServiceAuthorizedApis获取获得授权的API信息列表。1级
AbolishDataServiceApi调用AbolishDataServiceApi下线数据服务API。3级
GetDataServiceApplication调用GetDataServiceApplication查询数据服务App的详情。1级
ListDataServiceApplications调用ListDataServiceApplications获取数据服务应用的基础信息列表。1级
CreateDataServiceFolder调用CreateDataServiceFolder创建数据服务文件夹。2级
GetDataServiceFolder调用GetDataServiceFolder查询数据服务文件夹。1级
ListDataServiceFolders调用ListDataServiceFolders查询数据服务文件夹列表。1级
CreateDataServiceGroup调用CreateDataServiceGroup创建数据服务业务流程。2级
GetDataServiceGroup调用GetDataServiceGroup查询数据服务业务流程。1级
ListDataServiceGroups调用ListDataServiceGroups查询数据服务业务流程列表。1级
CreateDataServiceApiAuthority调用CreateDataServiceApiAuthority新增数据服务API授权。1级
DeleteDataServiceApiAuthority调用DeleteDataServiceApiAuthority取消数据服务API授权。1级

数据分析

API名称API描述API级别最低版本要求

(本版本及以上版本支持)

UmountDirectory调用UmountDirectory将指定内容从数据分析左侧导航目录中移除。2级基础版
MountDirectory调用MountDirectory将指定内容挂载到数据分析左侧导航目录。2级基础版

数据保护伞

API名称API描述API级别最低版本要求

(本版本及以上版本支持)

GetOpSensitiveData调用GetOpSensitiveData,获取租户下所有DataWorks工作空间指定日期的敏感数据访问记录。1级标准版
DesensitizeData调用DesensitizeData输入待脱敏数据,返回脱敏后的结果数据。1级专业版
GetOpRiskData调用GetOpRiskData,获取租户下所有DataWorks工作空间指定日期中有风险的敏感数据访问记录。1级标准版
GetSensitiveData调用GetSensitiveData,获取租户下所有DataWorks工作空间的最新敏感数据识别结果。1级标准版
ScanSensitiveData调用ScanSensitiveData识别输入数据中是否存在敏感数据。1级标准版

迁移助手

API名称API描述API级别最低版本要求

(本版本及以上版本支持)

CreateImportMigration调用CreateImportMigration创建导入任务,导入任务包含数据源信息、任务、表等对象的DataWorks导入导出包。2级基础版
GetMigrationProcess调用GetMigrationProcess获取导入导出任务的进度状态。1级
StartMigration调用StartMigration启动执行导入导出任务。2级
CreateExportMigration调用CreateExportMigration,新建一个DataWorks的导出任务。该API仅创建导出任务,不会启动执行导出任务。2级
GetMigrationSummary调用GetMigrationSummary,获取导入导出任务的信息。2级
ListMigrations调用ListMigrations,获取导入导出任务的列表。2级

安全中心

API名称API描述API级别最低版本要求

(本版本及以上版本支持)

CreatePermissionApplyOrder调用CreatePermissionApplyOrder创建一个权限申请单。2级基础版
GetPermissionApplyOrderDetail调用GetPermissionApplyOrderDetail查询一个权限申请单的详细信息。2级
ListPermissionApplyOrders调用ListPermissionApplyOrders查询权限申请单列表。3级
ApprovePermissionApplyOrder调用ApprovePermissionApplyOrder审批一个权限申请单。2级
RevokeColumnPermission调用RevokeColumnPermission,撤销用户的表字段权限。2级
RevokeTablePermission调用RevokeTablePermission,撤销用户的表权限。2级

开放平台

API名称API描述API级别最低版本要求
ListExtensions调用ListExtensions拉取开放平台的扩展程序列表。1级企业版
GetExtension调用GetExtension获取某个扩展程序详情。1级
GetOptionValueForProject调用GetOptionValueForProject获取扩展程序选项配置在项目空间下的配置。1级
ListEnabledExtensionsForProject调用ListEnabledExtensionsForProject来获取项目空间下已经开启的扩展程序列表,包含系统扩展程序和自定义扩展程序。1级

相关参数获取方式

  • 查看个人信息(AccessKey、UID)
    1. 进入RAM访问控制。
    2. 身份管理 > 用户页面,单击目标用户,进入用户详情页查看用户的详细信息(例如,UID)。
    3. 用户详情页面的认证管理 > 用户AccessKey区域,获取个人AccessKey信息。
  • 查看当前工作空间所在地域(RegionId)
    您可通过工作空间数据开发(DataStudio)模块的URL获取工作空间所在地域。示例如下图。
    说明 进入数据开发模块的操作,请参见进入数据开发
    工作空间
  • 查看工作空间ID(RegionId)
    工作空间ID为每个工作空间所拥有的唯一标识。您可通过如下步骤获取:
    1. 登录DataWorks控制台
    2. 在左侧导航栏单击工作空间列表,鼠标悬停至目标工作空间后的更多图标,单击工作空间配置
    3. 基本属性区域获取工作空间ID
  • 查看租户ID(tenantId)
    每个阿里云主账号都拥有自己的租户ID,用来与其他阿里云主账号进行区分。同一阿里云主账号下各RAM用户(即子账号)均属于该租户,即同账号的主账号与子账号租户ID相同。租户ID可通过如下步骤获取:
    1. 进入数据开发。
    2. 在数据开发(DataStudio)页面,单击右上方当前登录用户名称,单击菜单 > 用户信息,获取租户ID

常见问题