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

Cria uma API de serviço de dados.

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
TenantId	integer	Não	O ID do tenant.	10001
ProjectId	integer	Sim	O ID do espaço de trabalho.	10000
ApiName	string	Sim	O nome da API. O nome pode conter letras, caracteres chineses, dígitos e sublinhados (_). Deve começar com uma letra ou um caractere chinês e ter de 4 a 50 caracteres de comprimento.	Test API name
GroupId	string	Sim	O ID do fluxo de trabalho.	Business process ID
ApiMode	integer	Sim	O tipo da API. Valores válidos: 0 (API de assistente), 1 (API de script) e 2 (API registrada).	0
RequestMethod	integer	Sim	O método de solicitação da API. Valores válidos: 0 (GET), 1 (POST), 2 (PUT) e 3 (DELETE). As APIs de assistente e de script suportam GET e POST. As APIs registradas suportam GET, POST, PUT e DELETE.	0
ResponseContentType	integer	Sim	O tipo de dados de resposta da API. Valores válidos: 0 (JSON) e 1 (XML). As APIs de assistente e de script suportam JSON. As APIs registradas suportam JSON e XML.	0
Timeout	integer	Sim	O período de tempo limite. Unidade: milissegundos. Valores válidos: (0, 30000].	10000
VisibleRange	integer	Sim	O escopo de visibilidade. Valores válidos: 0 (espaço de trabalho) e 1 (privado).	0
Protocols	string	Sim	Os protocolos da API. Valores válidos: 0 (HTTP) e 1 (HTTPS). Vários valores são suportados e devem ser separados por vírgulas (,).	0,1
WizardDetails	string	Não	Os detalhes da API de assistente. Para obter mais informações sobre a string JSON do campo wizardDetails, consulte GetDataServiceApi.	{"isPagedResponse":true,"wizardConnection":{"connectionId":122786,"tableName":"person"},"wizardRequestParameters":[{"columnName":"id","defaultValue":"","exampleValue":"1","isRequiredParameter":true,"parameterDataType":2,"parameterDescription":"","parameterName":"id","parameterOperator":0,"parameterPosition":0}],"wizardResponseParameters":[{"columnName":"id","exampleValue":"11","parameterDataType":2,"parameterDescription":"","parameterName":"id"}]}
ScriptDetails	string	Não	Os detalhes da API de script. Para obter mais informações sobre a string JSON do campo scriptDetails, consulte GetDataServiceApi.	{"isPagedResponse":false,"script":"select id as id1, name as name1 from person where id=${inputid}","scriptConnection":{"connectionId":122786,"tableName":"person"},"scriptRequestParameters":[{"defaultValue":"","exampleValue":"","isRequiredParameter":true,"parameterDataType":0,"parameterDescription":"","parameterName":"inputid","parameterOperator":0,"parameterPosition":1}],"scriptResponseParameters":[{"exampleValue":"","parameterDataType":0,"parameterDescription":"","parameterName":"id1"},{"exampleValue":"","parameterDataType":0,"parameterDescription":"","parameterName":"name1"}]}
RegistrationDetails	string	Não	Os detalhes da API registrada. Para obter mais informações sobre a string JSON do campo registrationDetails, consulte GetDataServiceApi.	{"failedResultSample":"fail","registrationErrorCodes":[{"errorCode":"e1","errorMessage":"msg1","errorSolution":"sol1"},{"errorCode":"e2","errorMessage":"msg2","errorSolution":"sol2"}],"registrationRequestParameters":[{"columnName":"","defaultValue":"","exampleValue":"","isRequiredParameter":true,"parameterDataType":0,"parameterDescription":"","parameterName":"id","parameterOperator":0,"parameterPosition":1},{"columnName":"","defaultValue":"xx","exampleValue":"","isRequiredParameter":true,"parameterDataType":0,"parameterDescription":"","parameterName":"cc","parameterOperator":2,"parameterPosition":2}],"serviceContentType":1,"serviceHost":"http://www.baidu.com","servicePath":"/[uid]","serviceRequestBodyDescription":"body","successfulResultSample":"success"}
ApiPath	string	Sim	O caminho da API. O caminho pode conter letras, dígitos, sublinhados (_) e hifens (-). Deve começar com uma barra (/) e não pode exceder 200 caracteres de comprimento.	/test/1
ApiDescription	string	Sim	A descrição da API.	Test API description
FolderId	integer	Não	O ID da pasta de destino onde a API é criada. O ID da pasta raiz em um fluxo de trabalho é 0. O ID de uma pasta criada pelo usuário é maior que 0.	0
SqlMode	integer	Não	O modo SQL. Valores válidos: 0: modo básico 1: MyBatis.	0
ResourceGroupId	integer	Não	O ID do grupo de recursos exclusivo.	3242432423
RequestContentType	integer	Não	O tipo de dados da solicitação. Valores válidos: 0: XML 1: JSON 2: form. Valores válidos: 0 : xml. 1 : json. 2 : form.	0

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A estrutura de dados da resposta.
HttpStatusCode	integer	O código de status HTTP.	200
Data	integer	O ID da API criada.	100003
ErrorMessage	string	A mensagem de erro.	The connection does not exist.
RequestId	string	O ID da solicitação.	0000-ABCD-EFG****
ErrorCode	string	O código de erro.	Invalid.Tenant.ConnectionNotExists
Success	boolean	Indica se a chamada foi bem-sucedida.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "HttpStatusCode": 200,
  "Data": 100003,
  "ErrorMessage": "A conexão não existe",
  "RequestId": "0000-ABCD-EFG****",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true
}

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.	Você não tem as permissões necessárias. Conceda as permissões primeiro.
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.