Atualiza as informações do estado de desenvolvimento de uma API de serviço de dados.
Experimente agora
Testar
Autorização RAM
Parâmetros da solicitação
|
Parâmetro |
Tipo |
Obrigatório |
Descrição |
Exemplo |
| TenantId |
integer |
Não |
O ID do locatário. Você pode fazer login no console do DataWorks, acessar a página Data Studio, clicar no nome de usuário no canto superior direito e escolher Menu > Informações do Usuário para obter o ID do locatário. |
10001 |
| ProjectId |
integer |
Sim |
O ID do espaço de trabalho. |
10001 |
| ApiId |
integer |
Sim |
O ID da API. |
10000 |
| RequestMethod |
integer |
Sim |
O método de solicitação da API. Valores válidos: 0 (GET), 1 (POST), 2 (PUT) e 3 (DELETE). APIs de assistente e de script suportam GET e POST. 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). APIs de assistente e de script suportam JSON. APIs registradas suportam JSON e XML. |
0 |
| Timeout |
integer |
Sim |
O tempo limite, em 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 |
O protocolo da API. Valores válidos: 0 (HTTP) e 1 (HTTPS). Vários valores são suportados. Separe vários valores com vírgulas (,). |
0,1 |
| WizardDetails |
string |
Não |
Os detalhes da API de assistente. Para mais informações, consulte a string JSON do campo wizardDetails na operação 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 mais informações, consulte a string JSON do campo scriptDetails na operação 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 mais informações, consulte a string JSON do campo registrationDetails na operação 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. |
/test/2 |
| ApiDescription |
string |
Sim |
A descrição da API. |
Test API description |
| ResourceGroupId |
integer |
Não |
O ID do grupo de recursos exclusivo. |
3242432423 |
Elementos de resposta
|
Elemento |
Tipo |
Descrição |
Exemplo |
|
object |
|||
| HttpStatusCode |
integer |
O código de status HTTP. |
200 |
| Data |
boolean |
Indica se a atualização da API foi bem-sucedida. |
true |
| 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": true,
"ErrorMessage": "The connection does not exist.",
"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.