Todos os produtos
Search
Central de documentação

DataWorks:ListCalcEngines

Última atualização: Oct 28, 2026

Consulta a lista de fontes de dados vinculadas no Data Studio em um workspace do DataWorks especificado.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

  • Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.

  • API: A API que você pode chamar para executar a ação.

  • Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.

  • Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.

    • Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.

    • Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.

  • Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.

  • Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

dataworks:*

get

*All resources.

*

Nenhuma Nenhuma

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

ProjectId

integer

Sim

O ID do workspace do DataWorks ao qual as fontes de dados pertencem.

466230

Name

string

Não

O nome da fonte de dados a ser consultada. Correspondência exata.

test_mc

CalcEngineType

string

Sim

O tipo da fonte de dados a ser consultada. Este parâmetro não diferencia maiúsculas de minúsculas. Valores válidos:

  • ODPS

  • EMR

  • BLINK

  • HOLO

  • MaxGraph

  • HYBRIDDB_FOR_POSTGRESQL

  • ADB_MYSQL

  • HADOOP_CDH

  • CLICKHOUSE

ODPS

EnvType

string

Não

O ambiente ao qual a fonte de dados pertence. Valores válidos:

  • DEV: Ambiente de desenvolvimento.

  • PRD: Ambiente de produção.

PRD

PageSize

integer

Não

O volume de dados por página para paginação em uma consulta paginada. Valor padrão: 10. Valor máximo: 100.

10

PageNumber

integer

Não

O número da página para paginação em uma consulta paginada. O valor deve ser um número inteiro positivo maior ou igual a 1. Valor padrão: 1.

1

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

A resposta.

HttpStatusCode

integer

O código de status HTTP.

200

RequestId

string

O ID da solicitação.

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

Success

boolean

Indica se a solicitação foi bem-sucedida. Valores válidos:

  • true: A solicitação foi bem-sucedida.

  • false: A solicitação falhou.

true

Data

object

Os resultados de paginação da consulta paginada.

PageNumber

integer

O número da página.

1

PageSize

integer

O número de entradas retornadas por página.

20

TotalCount

integer

O número total de fontes de dados.

1

CalcEngines

array<object>

A lista de fontes de dados.

array<object>

As informações da fonte de dados.

BindingProjectName

string

O nome do workspace associado à fonte de dados.

test_project

IsDefault

boolean

Indica se a fonte de dados é a fonte de dados padrão do tipo atual.

true

EngineId

integer

O ID da fonte de dados.

35

DwRegion

string

A região onde está localizado o workspace do DataWorks associado à fonte de dados.

cn-zhangjiakou

TaskAuthType

string

A identidade de acesso da fonte de dados. Valores válidos:

  • USER: O usuário atual.

  • PROJECT: O usuário de execução do projeto.

  • SUBACCOUNT: O usuário RAM.

  • STS_ROLE: A função STS.

PROJECT

CalcEngineType

string

O tipo da fonte de dados.

ODPS

EngineInfo

object

As informações detalhadas da fonte de dados.

  • 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.alibabacloud.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" }

EnvType

string

O ambiente onde a fonte de dados está localizada. Valores válidos:

  • DEV: Ambiente de desenvolvimento.

  • PRD: Ambiente de produção.

PRD

Region

string

A região onde a fonte de dados está localizada.

cn-zhangjiakou

GmtCreate

string

A hora em que a fonte de dados foi criada.

Oct 10, 2019 3:42:44 PM

BindingProjectId

integer

O ID do workspace ao qual a fonte de dados pertence.

466230

Name

string

O nome de exibição da fonte de dados.

test_mc

TenantId

integer

O ID do tenant.

1234567

Exemplos

Resposta de sucesso

JSON formato

{
  "HttpStatusCode": 200,
  "RequestId": "0bc1ec92159376****",
  "Success": true,
  "Data": {
    "PageNumber": 1,
    "PageSize": 20,
    "TotalCount": 1,
    "CalcEngines": [
      {
        "BindingProjectName": "abc",
        "IsDefault": true,
        "EngineId": 35,
        "DwRegion": "cn-zhangjiakou",
        "TaskAuthType": "PROJECT",
        "CalcEngineType": "ODPS",
        "EngineInfo": {
          "pubEndpoint": "http://service.cn.maxcompute.aliyun.com/api",
          "endpoint": "http://service.cn.maxcompute.aliyun-inc.com/api",
          "resourceGroupType": "ODPS",
          "resourceGroupId": "361826516****",
          "vpcEndpoint": "http://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": 27,
        "Name": "abc",
        "TenantId": 1234567
      }
    ]
  }
}

Códigos de erro

Código de status HTTP

Código de erro

Mensagem de erro

Descrição

400 Invalid.Tenant.ConnectionNotExists The connection does not exist. A origem de dados não existe.
400 Invalid.Tenant.ProjectNotExists The project does not exist. O projeto não existe.
400 Invalid.Tenant.UserNotInProject The user is not in the project. O usuário não existe no projeto.
400 Invalid.CalcEngineEnvType The specified envType %s is invalid. O tipo de ambiente do mecanismo especificado é inválido.
400 Invalid.CalcEngineType The specified calcEngineType %s is invalid. O tipo de mecanismo especificado é inválido.
403 Invalid.Tenant.UserIsNotProjectOwnerOrAdmin The user is not a project administrator or owner. O usuário não é o proprietário nem o administrador do projeto.
403 Invalid.Tenant.UserNotInTenant The user is not in tenant. O membro a ser adicionado não existe no locatário.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.