GetDataServicePublishedApi - DataWorks: Central de Documentação do Alibaba Cloud

Obtém os detalhes de uma API publicada do DataService Studio.

Descrição da operação

前置条件：请先开通 DataWorks 企业版或旗舰版，并准备已发布的数据服务 API。ProjectId 可通过 ListProjects 获取，ApiId 可通过 ListDataServicePublishedApis 的 Data.Apis[].ApiId 获取；未开通所需版本时会返回 403 Forbidden.Access。

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

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ProjectId	integer	Sim	O ID do espaço de trabalho.	10002
TenantId	integer	Não	O ID do locatário. Para obter o ID do locatário, execute as seguintes etapas: faça login no console do DataWorks. Encontre seu espaço de trabalho e acesse a página Data Studio. Na página Data Studio, clique no nome de usuário de login no canto superior direito e clique em User Info na seção Menu.	10003
ApiId	integer	Sim	O ID da API.	10001

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
HttpStatusCode	integer	O código de status HTTP retornado.	200
RequestId	string	O ID da solicitação.	0000-ABCD-EFG****
ErrorMessage	string	A mensagem de erro retornada.	The connection does not exist.
Success	boolean	Indica se a solicitação foi bem-sucedida.	true
ErrorCode	string	O código de erro retornado.	Invalid.Tenant.ConnectionNotExists
Data	object	As informações mais recentes do estado de publicação da API.
Timeout	integer	O período de tempo limite da solicitação da API. Unidade: milissegundos.	10000
Status	integer	O status da API. Valores válidos: 0 e 1. O valor 0 indica que a API não está publicada. O valor 1 indica que a API está publicada.	1
ApiId	integer	O ID da API do DataService Studio.	10000
ApiMode	integer	O tipo da API. Valores válidos: 0, 1 e 2. O valor 0 indica que a API é gerada no modo assistente. O valor 1 indica que a API é gerada no modo script. O valor 2 indica que a API é gerada por registro.	0
ProjectId	integer	O ID do espaço de trabalho.	10001
ResponseContentType	integer	O formato no qual a resposta da solicitação da API é retornada. Valores válidos: 0 e 1. O valor 0 indica o formato JSON. O valor 1 indica o formato XML. APIs geradas no modo assistente ou script suportam o formato JSON. APIs geradas por registro suportam os formatos JSON e XML.	0
CreatorId	string	O ID da conta Alibaba Cloud usada pelo criador da API.	1234567
VisibleRange	integer	O escopo no qual a API é visível. Valores válidos: 0 e 1. O valor 0 indica que a API é visível para os membros em um espaço de trabalho específico. O valor 1 indica que a API é visível apenas para o criador da API.	0
ModifiedTime	string	A hora em que a API foi modificada pela última vez.	2020-06-23T00:21:01+0800
OperatorId	string	O ID da conta Alibaba Cloud usada pelo usuário que modificou a API pela última vez.	2345678
GroupId	string	O ID do grupo.	ab12**
Description	string	A descrição.	Test API description
RequestMethod	integer	O método de solicitação da API. Valores válidos: 0, 1, 2 e 3. O valor 0 indica o método GET, o valor 1 indica o método POST, o valor 2 indica o método PUT e o valor 3 indica o método DELETE. APIs geradas no modo assistente ou script suportam os métodos GET e POST. APIs geradas por registro suportam os métodos GET, POST, PUT e DELETE.	0
CreatedTime	string	A hora de criação.	2020-06-23T00:21:01+0800
ApiName	string	O nome da API.	Test API name
TenantId	integer	O ID do locatário.	10001
ApiPath	string	O caminho da API.	/test/1
Protocols	array	O protocolo usado pela API. Valores válidos: 0 e 1. O valor 0 indica HTTP. O valor 1 indica HTTPS. Vários protocolos são apresentados em uma lista.
	integer	O protocolo usado pela API. Valores válidos: 0 e 1. O valor 0 indica que a API usa HTTP. O valor 1 indica que a API usa HTTPS. Vários protocolos são apresentados em uma lista.	0
RegistrationDetails	object	Detalhes da API registrada. Retornados apenas para APIs registradas.
ServiceHost	string	A URL do serviço de back-end.	http://www.abc.com
ServiceContentType	integer	O formato no qual a resposta da solicitação da API é retornada. Valores válidos: 0 e 1. O valor 0 indica o formato JSON. O valor 1 indica o formato XML. APIs geradas no modo assistente ou script suportam o formato JSON. APIs geradas por registro suportam os formatos JSON e XML.	0
ServicePath	string	O caminho do serviço de back-end.	/index
SuccessfulResultSample	string	A amostra de resposta de sucesso da API.	{"success": true}
FailedResultSample	string	A amostra de resposta de erro da API.	{"success": false}
ServiceRequestBodyDescription	string	A descrição do corpo da solicitação iniciada para chamar o serviço de back-end.	{"abc":1}
RegistrationErrorCodes	array<object>	A lista de códigos de erro para a API registrada.
	object
ErrorMessage	string	A mensagem de erro.	The connection does not exist.
ErrorCode	string	O código de erro.	Invalid.Tenant.ConnectionNotExists
ErrorSolution	string	A solução.	retry
RegistrationRequestParameters	array<object>	A lista de parâmetros de solicitação para a API registrada.
	object	O resultado retornado.
ParameterName	string	O nome do parâmetro.	name1
ParameterPosition	integer	A posição do parâmetro. Valores válidos: 0, 1, 2 e 3. O valor 0 indica que o parâmetro está no caminho da URL da solicitação. O valor 1 indica que o parâmetro está no parâmetro Query da URL da solicitação. O valor 2 indica que o parâmetro está no cabeçalho da solicitação. O valor 3 indica que o parâmetro está no corpo da solicitação. APIs geradas no modo assistente ou script suportam apenas a posição Query. APIs geradas por registro cujo método de solicitação é GET ou DELETE suportam as posições Query e Head. APIs geradas por registro cujo método de solicitação é PUT ou POST suportam as posições Query, Head e Body.	0
ParameterDescription	string	A descrição.	description1
DefaultValue	string	O valor padrão.	default1
ParameterOperator	integer	O operador usado para o valor do parâmetro. Valores válidos: 0, 1, 2 e 3. O valor 0 indica o operador Equal. O valor 1 indica o operador Like. O valor 2 indica o operador Const. O valor 3 indica o operador In. APIs geradas no modo assistente suportam os operadores Equal, Like e In. APIs geradas no modo script suportam o operador Equal. APIs geradas por registro suportam os operadores Equal e Const.	0
ExampleValue	string	O valor de amostra.	example1
ParameterDataType	integer	O tipo de dados do parâmetro. Valores válidos: 0: String 1: Int 2: Long 3: Float 4: Double 5: Boolean 6: StringList 7: IntList 8: LongList 9: FloatList 10: DoubleList 11: BooleanList	0
IsRequiredParameter	boolean	Indica se o parâmetro é obrigatório.	true
ScriptDetails	object	Os detalhes da API gerada no modo script. Este parâmetro é retornado apenas se a API for gerada no modo script.
IsPagedResponse	boolean	Indica se as entradas são retornadas por página.	true
SuccessfulResultSample	string	A amostra de resposta de sucesso da API.	{"success": true}
FailedResultSample	string	A amostra de resposta de erro da API.	{"success": false}
Script	string	O script SQL.	select a from t
ScriptErrorCodes	array<object>	Os códigos de erro retornados para a API gerada no modo script.
	object	O resultado retornado.
ErrorMessage	string	A mensagem de erro.	fail to call
ErrorCode	string	O código de erro.	1001
ErrorSolution	string	A solução usada para corrigir o erro.	retry
ScriptRequestParameters	array<object>	Os parâmetros de solicitação da API gerada no modo script.
	object	O resultado retornado.
ParameterName	string	O nome do parâmetro.	param1
ParameterPosition	integer	A posição do parâmetro. Valores válidos: 0: indica que o parâmetro está no caminho da URL da solicitação. 1: indica que o parâmetro está no parâmetro Query da URL da solicitação. 2: indica que o parâmetro está no cabeçalho da solicitação. 3: indica que o parâmetro está no corpo da solicitação. APIs geradas no modo assistente ou script suportam apenas a posição Query. APIs geradas por registro cujo método de solicitação é GET ou DELETE suportam as posições Query e Head. APIs geradas por registro cujo método de solicitação é PUT ou POST suportam as posições Query, Head e Body.	0
ParameterDescription	string	A descrição.	description1
DefaultValue	string	O valor padrão.	default1
ParameterOperator	integer	O operador usado para o valor do parâmetro. Valores válidos: 0: Equal 1: Like 2: Const 3: In APIs geradas no modo assistente suportam os operadores Equal, Like e In. APIs geradas no modo script suportam o operador Equal. APIs geradas por registro suportam os operadores Equal e Const.	0
ExampleValue	string	O valor de amostra.	example1
ParameterDataType	integer	O tipo de dados do parâmetro. Valores válidos: 0: String 1: Int 2: Long 3: Float 4: Double 5: Boolean 6: StringList 7: IntList 8: LongList 9: FloatList 10: DoubleList 11: BooleanList	0
IsRequiredParameter	boolean	Indica se o parâmetro é obrigatório.	true
ScriptResponseParameters	array<object>	Os parâmetros de resposta da API gerada no modo script.
	object	O resultado retornado.
ParameterDescription	string	A descrição.	description2
ParameterName	string	O nome do parâmetro.	param2
ExampleValue	string	O valor de amostra.	example2
ParameterDataType	integer	O tipo de dados do parâmetro. Valores válidos: 0: String 1: Int 2: Long 3: Float 4: Double 5: Boolean 6: StringList 7: IntList 8: LongList 9: FloatList 10: DoubleList 11: BooleanList	0
ScriptConnection	object	As informações da fonte de dados da API gerada no modo script.
TableName	string	O nome da tabela na fonte de dados.	t
ConnectionId	integer	O ID da fonte de dados.	123
WizardDetails	object	Os detalhes da API gerada no modo assistente. Este parâmetro é retornado apenas se a API for gerada no modo assistente.
IsPagedResponse	boolean	Indica se as entradas são retornadas por página.	true
SuccessfulResultSample	string	A amostra de resposta de sucesso da API.	{"success": true}
FailedResultSample	string	A amostra de resposta de erro da API.	{"success": false}
WizardErrorCodes	array<object>	Os códigos de erro retornados para a API gerada no modo assistente.
	object	O resultado retornado.
ErrorMessage	string	A mensagem de erro.	fail to call
ErrorCode	string	O código de erro.	1001
ErrorSolution	string	A solução usada para corrigir o erro.	retry
WizardRequestParameters	array<object>	Os parâmetros de solicitação da API gerada no modo assistente.
	object	O resultado retornado.
ParameterName	string	O nome do parâmetro.	param1
ParameterPosition	integer	A posição do parâmetro. Valores válidos: 0, 1, 2 e 3. O valor 0 indica que o parâmetro está no caminho da URL da solicitação. O valor 1 indica que o parâmetro está no parâmetro Query da URL da solicitação. O valor 2 indica que o parâmetro está no cabeçalho da solicitação. O valor 3 indica que o parâmetro está no corpo da solicitação. APIs geradas no modo assistente ou script suportam apenas a posição Query. APIs geradas por registro cujo método de solicitação é GET ou DELETE suportam as posições Query e Head. APIs geradas por registro cujo método de solicitação é PUT ou POST suportam as posições Query, Head e Body.	0
ParameterDescription	string	A descrição.	description1
DefaultValue	string	O valor padrão.	default1
ParameterOperator	integer	O operador usado para o valor do parâmetro. Valores válidos: 0, 1, 2 e 3. O valor 0 indica o operador Equal. O valor 1 indica o operador Like. O valor 2 indica o operador Const. O valor 3 indica o operador In. APIs geradas no modo assistente suportam os operadores Equal, Like e In. APIs geradas no modo script suportam o operador Equal. APIs geradas por registro suportam os operadores Equal e Const.	0
ExampleValue	string	O valor de amostra.	example1
ParameterDataType	integer	O tipo de dados do parâmetro. Valores válidos: 0: String 1: Int 2: Long 3: Float 4: Double 5: Boolean 6: StringList 7: IntList 8: LongList 9: FloatList 10: DoubleList 11: BooleanList	0
IsRequiredParameter	boolean	Indica se o parâmetro é obrigatório.	true
WizardResponseParameters	array<object>	Os parâmetros de resposta da API gerada no modo assistente.
	object	A lista de parâmetros de resposta no modo assistente.
ParameterDescription	string	A descrição.	description2
ParameterName	string	O nome do parâmetro.	param2
ExampleValue	string	O valor de amostra.	example2
ParameterDataType	integer	O tipo de dados do parâmetro. Valores válidos: 0: String 1: Int 2: Long 3: Float 4: Double 5: Boolean 6: StringList 7: IntList 8: LongList 9: FloatList 10: DoubleList 11: BooleanList	0
WizardConnection	object	As informações da fonte de dados da API gerada no modo assistente.
TableName	string	O nome da tabela na fonte de dados.	t
ConnectionId	integer	O ID da fonte de dados.	123
SqlMode	integer	O modo SQL. 0: SQL básico; 1: SQL avançado.	0

Os detalhes de diferentes tipos de API são retornados em campos diferentes. As APIs do tipo Wizard usam o campo WizardDetails, as APIs de script usam o campo ScriptDetails e as APIs de registro usam o campo RegistrationDetails.

Exemplos

Resposta de sucesso

JSON formato

{
  "HttpStatusCode": 200,
  "RequestId": "0000-ABCD-EFG****",
  "ErrorMessage": "The connection does not exist.",
  "Success": true,
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Data": {
    "Timeout": 10000,
    "Status": 1,
    "ApiId": 10000,
    "ApiMode": 0,
    "ProjectId": 10001,
    "ResponseContentType": 0,
    "CreatorId": "1234567",
    "VisibleRange": 0,
    "ModifiedTime": "2020-06-23T00:21:01+0800",
    "OperatorId": "2345678",
    "GroupId": "ab12**",
    "Description": "测试API描述",
    "RequestMethod": 0,
    "CreatedTime": "2020-06-23T00:21:01+0800",
    "ApiName": "测试API名称",
    "TenantId": 10001,
    "ApiPath": "/test/1",
    "Protocols": [
      0
    ],
    "RegistrationDetails": {
      "ServiceHost": "http://www.abc.com",
      "ServiceContentType": 0,
      "ServicePath": "/index",
      "SuccessfulResultSample": "{\"success\": true}",
      "FailedResultSample": "{\"success\": false}",
      "ServiceRequestBodyDescription": "{\"abc\":1}",
      "RegistrationErrorCodes": [
        {
          "ErrorMessage": "The connection does not exist.",
          "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
          "ErrorSolution": "retry"
        }
      ],
      "RegistrationRequestParameters": [
        {
          "ParameterName": "name1",
          "ParameterPosition": 0,
          "ParameterDescription": "description1",
          "DefaultValue": "default1",
          "ParameterOperator": 0,
          "ExampleValue": "example1",
          "ParameterDataType": 0,
          "IsRequiredParameter": true
        }
      ]
    },
    "ScriptDetails": {
      "IsPagedResponse": true,
      "SuccessfulResultSample": "{\"success\": true}",
      "FailedResultSample": "{\"success\": false}",
      "Script": "select a from t",
      "ScriptErrorCodes": [
        {
          "ErrorMessage": "fail to call",
          "ErrorCode": "1001",
          "ErrorSolution": "retry"
        }
      ],
      "ScriptRequestParameters": [
        {
          "ParameterName": "param1",
          "ParameterPosition": 0,
          "ParameterDescription": "description1",
          "DefaultValue": "default1",
          "ParameterOperator": 0,
          "ExampleValue": "example1",
          "ParameterDataType": 0,
          "IsRequiredParameter": true
        }
      ],
      "ScriptResponseParameters": [
        {
          "ParameterDescription": "description2",
          "ParameterName": "param2",
          "ExampleValue": "example2",
          "ParameterDataType": 0
        }
      ],
      "ScriptConnection": {
        "TableName": "t",
        "ConnectionId": 123
      }
    },
    "WizardDetails": {
      "IsPagedResponse": true,
      "SuccessfulResultSample": "{\"success\": true}",
      "FailedResultSample": "{\"success\": false}",
      "WizardErrorCodes": [
        {
          "ErrorMessage": "fail to call",
          "ErrorCode": "1001",
          "ErrorSolution": "retry"
        }
      ],
      "WizardRequestParameters": [
        {
          "ParameterName": "param1",
          "ParameterPosition": 0,
          "ParameterDescription": "description1",
          "DefaultValue": "default1",
          "ParameterOperator": 0,
          "ExampleValue": "example1",
          "ParameterDataType": 0,
          "IsRequiredParameter": true
        }
      ],
      "WizardResponseParameters": [
        {
          "ParameterDescription": "description2",
          "ParameterName": "param2",
          "ExampleValue": "example2",
          "ParameterDataType": 0
        }
      ],
      "WizardConnection": {
        "TableName": "t",
        "ConnectionId": 123
      }
    },
    "SqlMode": 0
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
500	InternalError.System	An internal system error occurred. Try again later.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	Acesso negado. Autorize o acesso.
429	Throttling.Api	The request for this resource has exceeded your available limit.
429	Throttling.System	The DataWorks system is busy. Try again later.
429	Throttling.User	Your request is too frequent. Try again later.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.