文档

ListCalcEngines - 查看数据开发中绑定的数据源列表

更新时间:

该接口用于查询指定DataWorks工作空间的数据开发中绑定的数据源列表。

调试

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

授权信息

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

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

请求参数

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

数据源所属的 DataWorks 工作空间。

466230
Namestring

查询的数据源名称,精确匹配。

test_mc
CalcEngineTypestring

查询的数据源类型。目前范围如下,不区分大小写。

  • ODPS
  • EMR
  • BLINK
  • HOLO
  • MaxGraph
  • HYBRIDDB_FOR_POSTGRESQL
  • ADB_MYSQL
  • HADOOP_CDH
  • CLICKHOUSE
ODPS
EnvTypestring

数据源所属的环境。

  • DEV:开发环境
  • PRD:生产环境。
PRD
PageSizeinteger

分页查询时每页显示的数据量,默认为 10 条,最大 100 条。

10
PageNumberinteger

分页查询的页码。大于等于 1 的正整数,默认为 1。

1

返回参数

名称类型描述示例值
object

返回结果。

HttpStatusCodeinteger

请求返回码。

200
RequestIdstring

请求 ID。

1AFAE64E-D1BE-432B-A9****
Successboolean

请求是否成功,取值如下:

  • true:请求成功。
  • false:请求失败。
true
Dataobject

分页查询结果。

PageNumberinteger

页码。

1
PageSizeinteger

每页显示的条数。

20
TotalCountinteger

数据源的总数。

1
CalcEnginesarray<object>

数据源列表。

object

数据源信息。

BindingProjectNamestring

数据源关联的工作空间名称。

test_project
IsDefaultboolean

是否为当前类型的默认数据源。

true
EngineIdinteger

数据源 ID。

35
DwRegionstring

数据源关联的 DataWorks 工作空间所在的地域。

cn-zhangjiakou
TaskAuthTypestring

数据源的访问身份。

  • USER:当前用户。
  • PROJECT:项目执行用户。
  • SUBACCOUNT:子账号。
  • STS_ROLE:STS 角色。
PROJECT
CalcEngineTypestring

数据源类型。

ODPS
EngineInfoobject

数据源的详细信息。

  • ODPS
    {
      "pubEndpoint": "service.cn.maxcompute.aliyun.com/api",
      "endpoint": "service.cn.maxcompute.aliyun-inc.com/api",
      "initProperties": " 
      {\"odpsTypeMode\":\"STANDARD\",\"openPai\":false,\"openPaiGpu\":false}",
      "resourceGroupType": "ODPS",
      "resourceGroupId": "361826516****",
      "vpcEndpoint": "service.cn.maxcompute.aliyun-inc.com/api",
      "projectName": "onefall_test_zjk",
      "taskSameAsOwner": "true"
    }
    
  • EMR
    {
      "emrClusterId": "C-xxx",
      "specs": "{\"emrClusterId\":\"C-xxx\",\"emrAccessMode\":\"simple\",\"emrResourceQueueName\":\"default\",\"emrProjectId\":\"FP-xxx\"}",
      "endpoint": "emr.aliyuncs.com",
      "emrResourceQueueName": "default",
      "emrAccessMode": "simple",
      "resourceGroupType": "DW",
      "projectName": "xx-xxxx",
      "emrProjectId": "FP-xxxx",
      "taskSameAsOwner": "false"
    }   
    
  • BLINK
    {
      "bayesProjectId": "xxxx",
      "bayesProjectName": "xc_blxxixxxnk_1",
      "cluster": "xxxssxsx",
      "endpoint": "https://stream.console.aliyun.com",
      "engineType": "BLINK",
      "name": "xsxsxxxxx",
      "projectName": "xc_blxxxsxink_1",
      "queue": "root.xc_blxsxxxxxxink_1",
      "resourceGroupType": "DW",
      "specs": "{\"cluster\":\"xxxxxx\",\"bayesProjectName\":\"xc_blxxixxxnk_1\",\"bayesProjectId\":\"ssxxxsa\",\"name\":\"sxsxsxxx\",\"queue\":\"root.sxxsxxsx\"}",
      "taskSameAsOwner": false
    }
    
  • HOLO
    {
      "endpoint": "hgprecn-cn-xsxssxsx-cn-shanghai-internal.hologres.aliyuncs.com:80",
      "engineType": "ODPS",
      "odpsEndpoint": "hgprecn-cn-xsxssxxs-cn-shanghai-internal.hologres.aliyuncs.com:80",
      "odpsProjectName": "xsxssxsxsx",
      "projectName": "xsxssxsxsx",
      "resourceGroupType": "DW",
      "specs": "{\"pubEndpoint\":\"hgprecn-cn-xsxssxsxs-cn-shanghai.hologres.aliyuncs.com:80\",\"commonBuyInstanceId\":\"hgprecn-cn-xsxsxsxs\",\"project\":\"holo_upxsxgrade1\",\"common_buy_instance_id\":\"hgprecn-cn-xsxsxs\",\"endpoint\":\"hgprecn-cn-xsxxsxs-cn-shanghai-internal.hologres.aliyuncs.com:80\",\"port\":\"80\",\"host\":\"hgprecn-cn-xsxsxsxs-cn-shanghai-internal.hologres.aliyuncs.com\",\"vpcEndpoint\":\"hgprecn-cn-xsxsxsxs-cn-shanghai-vpc.hologres.aliyuncs.com:80\",\"authType\":2,\"region\":\"cn-shanghai\"}",
      "taskSameAsOwner": false
    }
    
  • MaxGraph
    {
      "endpoint": "http://pre-graphcompute.aliyuncs.com",
      "engineType": "ODPS",
      "odpsEndpoint": "http://pre-graphcompute.aliyuncs.com",
      "odpsProjectName": "xsxsxsxs",
      "projectName": "xsxsxsxs",
      "resourceGroupType": "DW",
      "taskSameAsOwner": false
    }
    
  • HYBRIDDB_FOR_POSTGRESQL
    {
      "endpoint": "hybriddb_for_postgresql_mo12121ck_endpoint",
      "engineType": "ODPS",
      "odpsEndpoint": "hybriddb_for_postgresql_m121212ock_endpoint",
      "odpsProjectName": "sxasaxsaxaxas",
      "projectName": "sxasaxsaxaxas",
      "resourceGroupType": "DW",
      "specs": "{\"connectionString\":\"gp-xsxsxsxxs.gpdb.rds.aliyuncs.com\",\"database\":\"xsxsxxsxs\",\"password\":\"xxxxxxx\",\"instanceId\":\"gp-cdcdacdacda\",\"port\":\"3432\",\"ownerId\":\"12121212\",\"username\":\"sdasaddsa\"}",
      "taskSameAsOwner": false
    }
    
  • ADB_MYSQL
    {
      "endpoint": "adb_mysql_mock_endpoint",
      "engineType": "ODPS",
      "odpsEndpoint": "adb_mysql_mock_endpoint",
      "odpsProjectName": "am-xsaxaxa",
      "projectName": "am-xsxsaxa",
      "resourceGroupType": "DW",
      "specs": "{\"connectionString\":\"am-xsaxsa.ads.aliyuncs.com:3306\",\"database\":\"xsaxsaxa\",\"password\":\"xsaxsaxassxsa\",\"instanceId\":\"am-xsaxsasx\",\"username\":\"xsaxsadsd\"}",
      "taskSameAsOwner": false
    }
    
  • HADOOP_CDH
    {
      "bindingBaseId": "xsaxsaxs",
      "endpoint": "xsaaaaa",
      "engineType": "ODPS",
      "odpsEndpoint": "axsxaxssxs",
      "odpsProjectName": "ssxxax",
      "projectName": "xsaxsaxsa",
      "resourceGroupId": 45208xxxxxx,
      "resourceGroupType": "GATEWAY",
      "specs": "{\"cluster\":{\"hive\":{\"hiveServer2Url\":\"jdbc:hive2://xxxxxxer-1-cn-shanghai-pre-kerberos-1:10000\",\"hiveMetastore\":\"thrift://xxxxxxxr-1-cn-shanghai-pre-kerberos-1:9083\",\"version\":\"2.1.1\"},\"configFiles\":{\"coreSite\":\"4534574xxxxxx\",\"hdfsSite\":\"453457919xxxxxxx\",\"mapredSite\":\"45345750xxxxxx\",\"yarnSite\":\"4534575xxxxx\",\"krb5Conf\":\"4534576xxxxx1\",\"hiveSite\":\"453457xxxxx20\"},\"spark\":{\"version\":\"2.4.0\"},\"cdh\":{\"version\":\"6.3.2\"},\"hdfs\":{\"version\":\"3.0.0\"},\"impala\":{\"impalaUrl\":\"jdbc:impala://cdh-xsxssxxsx-1-cn-shanghai-pre-kerberos-1:21050\",\"version\":\"3.2.0\"},\"yarn\":{\"YarnUrl\":\"http://cdh-xsxsxsxsxs-1-cn-shanghai-pre-kerberos-1:8032\",\"webUrl\":\"http://cdh-xsxsxssxxssx-1-cn-shanghai-pre-kerberos-1:8088\",\"version\":\"3.0.0\"},\"presto\":{\"prestoUrl\":\"jdbc:presto://cdh-xssxsxxsxsxs-1-cn-shanghai-pre-kerberos-1:8080/hive/default\",\"version\":\"0.244.1\"}},\"instanceId\":161sdads733,\"authDetail\":{\"principal\":\"hive@HADOOP.COM\",\"keytabFileId\":\"45345815xsxsxs3\",\"type\":\"kerberos\",\"username\":\"xsxsxsxsa@HADOOP.COM\"},\"resGroupStatus\":\"\",\"hadoopAuthType\":\"kerberos\",\"clusterIdentifier\":\"xssxsxsxsx\",\"clusterId\":xsxsx,\"resGroupId\":4520870619xsxssxxs,\"accessMode\":\"security\",\"authType\":2}",
      "taskSameAsOwner": false
    }
    
{ "pubEndpoint": "service.cn.maxcompute.aliyun.com/api", "endpoint": "service.cn.maxcompute.aliyun-inc.com/api", "initProperties": " {\"odpsTypeMode\":\"STANDARD\",\"openPai\":false,\"openPaiGpu\":false}", "resourceGroupType": "ODPS", "resourceGroupId": "361826516****", "vpcEndpoint": "service.cn.maxcompute.aliyun-inc.com/api", "projectName": "onefall_test_zjk", "taskSameAsOwner": "true" }
EnvTypestring

数据源所在的环境。

  • DEV:开发环境。
  • PRD:生产环境。
PRD
Regionstring

数据源所在的地域。

cn-zhangjiakou
GmtCreatestring

数据源的创建时间。

Oct 10, 2019 3:42:44 PM
BindingProjectIdinteger

数据源所在的工作空间 ID。

466230
Namestring

数据源的显示名称。

test_mc
TenantIdlong

租户 ID。

1234567

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "RequestId": "1AFAE64E-D1BE-432B-A9****",
  "Success": true,
  "Data": {
    "PageNumber": 1,
    "PageSize": 20,
    "TotalCount": 1,
    "CalcEngines": [
      {
        "BindingProjectName": "test_project",
        "IsDefault": true,
        "EngineId": 35,
        "DwRegion": "cn-zhangjiakou",
        "TaskAuthType": "PROJECT",
        "CalcEngineType": "ODPS",
        "EngineInfo": {
          "pubEndpoint": "service.cn.maxcompute.aliyun.com/api",
          "endpoint": "service.cn.maxcompute.aliyun-inc.com/api",
          "initProperties": " {\"odpsTypeMode\":\"STANDARD\",\"openPai\":false,\"openPaiGpu\":false}",
          "resourceGroupType": "ODPS",
          "resourceGroupId": "361826516****",
          "vpcEndpoint": "service.cn.maxcompute.aliyun-inc.com/api",
          "projectName": "onefall_test_zjk",
          "taskSameAsOwner": "true"
        },
        "EnvType": "PRD",
        "Region": "cn-zhangjiakou",
        "GmtCreate": "Oct 10, 2019 3:42:44 PM",
        "BindingProjectId": 466230,
        "Name": "test_mc",
        "TenantId": 1234567
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400Invalid.Tenant.ConnectionNotExistsThe connection does not exist.数据源不存在。
400Invalid.Tenant.ProjectNotExistsThe project does not exist.项目不存在。
400Invalid.Tenant.UserNotInProjectThe user is not in the project.用户不在项目中。
400Invalid.CalcEngineEnvTypeThe specified envType %s is invalid.传入的引擎环境类型非法
400Invalid.CalcEngineTypeThe specified calcEngineType %s is invalid.传入的引擎类型非法
403Invalid.Tenant.UserIsNotProjectOwnerOrAdminThe user is not a project administrator or owner.用户不是项目负责人或者项目管理员。
403Invalid.Tenant.UserNotInTenantThe user is not in tenant.用户不在租户中。

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

变更历史

变更时间变更内容概要操作
暂无变更历史