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

Consulta a lista de APIs publicadas do Data Service chamando ListDataServicePublishedApis.

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
PageNumber	integer	Não	O número da página. As páginas começam em 1. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página. Valor padrão: 10. Valor máximo: 50.	10
ProjectId	integer	Sim	O ID do espaço de trabalho.\n\nO valor de exemplo é apenas para demonstração de formato. Os valores válidos podem ser obtidos em PageResult.ProjectList[].ProjectId na resposta de ListProjects. Antes de chamar esta operação, ative o DataWorks Enterprise Edition ou Ultimate Edition. Caso contrário, o erro 403 Forbidden.Access será retornado.	10000
TenantId	integer	Não	O ID do locatário. Para obter o ID do locatário, faça login no console do DataWorks, acesse a página DataStudio, clique no seu nome de usuário no canto superior direito e escolha Menu > User Info.	10001
ApiNameKeyword	string	Não	A palavra-chave no nome da API. Apenas as APIs cujos nomes contêm esta palavra-chave são retornadas.	My API name
ApiPathKeyword	string	Não	A palavra-chave no caminho da API. Apenas as APIs cujos caminhos contêm esta palavra-chave são retornadas.	/test/
CreatorId	string	Não	O ID da Alibaba Cloud do criador da API. Apenas as APIs criadas por este usuário são retornadas.	12345

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
HttpStatusCode	integer	O código de status HTTP.	200
RequestId	string	O ID da solicitação. É um identificador único para a solicitação.	0000-ABCD-EFG****
ErrorMessage	string	A mensagem de erro.	The connection does not exist.
Success	boolean	Indica se a chamada foi bem-sucedida.	true
ErrorCode	string	O código de erro.	Invalid.Tenant.ConnectionNotExists
Data	object	As informações da API publicada retornadas.
PageNumber	integer	O número da página, que é igual ao valor de PageNumber na solicitação.	1
PageSize	integer	O número de entradas por página. Valor padrão: 10. Valor máximo: 100.	10
TotalCount	integer	O número total de registros.	100
Apis	array<object>	A lista de informações das APIs publicadas.
	array<object>
Timeout	integer	O período de tempo limite, em milissegundos (ms).	10000
Status	integer	O status da API. Valores válidos: 0: não publicada. 1: publicada.	1
ApiId	integer	O ID da API.	10002
ApiMode	integer	O tipo da API. Valores válidos: 0: API de assistente. 1: API de script. 2: API de registro.	0
ProjectId	integer	O ID do espaço de trabalho.	10000
ResponseContentType	integer	O tipo de dados de resposta da API. Valores válidos: 0: JSON. 1: XML. As APIs de assistente e de script suportam JSON. As APIs de registro suportam JSON e XML.	0
CreatorId	string	O ID da Alibaba Cloud do criador.	1234567
VisibleRange	integer	O intervalo de visibilidade. Valores válidos: 0: espaço de trabalho. 1: privado.	0
ModifiedTime	string	A hora da última modificação da API. O formato é `yyyy-MM-dd'T'HH:mm:ssZ`, por exemplo, `2020-06-23T00:21:01+0800`. O deslocamento de fuso horário neste exemplo é `+0800`.	2020-06-23T00:21:01+0800
OperatorId	string	O ID da Alibaba Cloud do usuário que editou a API pela última vez.	2345678
GroupId	string	O ID do grupo.	ab123
Description	string	A descrição.	Test API description
RequestMethod	integer	O método de solicitação da API. Valores válidos: 0: GET. 1: POST. 2: PUT. 3: DELETE. As APIs de assistente e de script suportam GET e POST. As APIs de registro suportam GET, POST, PUT e DELETE.	0
CreatedTime	string	A hora em que a API foi criada. O formato é `yyyy-MM-dd'T'HH:mm:ssZ`, por exemplo, `2020-06-23T00:21:01+0800`. O deslocamento de fuso horário neste exemplo é `+0800`.	2020-06-23T00:21:01+0800
ApiName	string	O nome da API.	My API name
TenantId	integer	O ID do locatário.	10001
ApiPath	string	O caminho da API.	/test/1
Protocols	array	O protocolo da API. Valores válidos: 0: HTTP. 1: HTTPS.
	integer	O protocolo da API. Valores válidos: 0: HTTP. 1: HTTPS.	0
RegistrationDetails	object	Os detalhes da API de registro. Este parâmetro é retornado apenas para APIs de registro.
ServiceHost	string	O endereço do serviço de back-end.	http://www.abc.com
ServiceContentType	integer	O tipo de dados de resposta da API. Valores válidos: 0: JSON. 1: XML. As APIs de assistente e de script suportam JSON. As APIs de registro suportam JSON e XML.	0
ServicePath	string	O caminho do serviço de back-end.	/index
SuccessfulResultSample	string	O exemplo de uma resposta bem-sucedida.	{"success": true}
FailedResultSample	string	O exemplo de uma resposta de erro.	{"success": false}
ServiceRequestBodyDescription	string	A descrição do conteúdo do corpo da solicitação de back-end.	{"abc":1}
RegistrationErrorCodes	array<object>	A lista de códigos de erro para a API de registro.
	object	A lista de códigos de erro para a API de registro.
ErrorMessage	string	A mensagem de erro.	fail to call
ErrorCode	string	O código de erro.	1001
ErrorSolution	string	A solução para o erro.	retry
RegistrationRequestParameters	array<object>	A lista de parâmetros de solicitação para a API de registro.
	object
ParameterName	string	O nome do parâmetro.	name1
ParameterPosition	integer	A posição do parâmetro. Valores válidos: 0: Path 1: Query 2: Head 3: Body As APIs de assistente e de script suportam apenas Query. Para APIs de registro, os métodos GET e DELETE suportam Query e Head, e os métodos PUT e POST suportam Query, Head e Body.	0
ParameterDescription	string	A descrição.	description1
DefaultValue	string	O valor padrão.	default1
ParameterOperator	integer	O operador. Valores válidos: 0: Equal 1: Like 2: Const 3: In As APIs de assistente suportam Equal, Like e In. As APIs de script suportam Equal. As APIs de registro suportam Equal e Const.	0
ExampleValue	string	O valor de exemplo.	example1
ParameterDataType	integer	O tipo de dados. 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 de script. Este parâmetro é retornado apenas para APIs de script.
IsPagedResponse	boolean	Indica se a resposta é paginada.	true
SuccessfulResultSample	string	O exemplo de uma resposta bem-sucedida.	{"success": true}
FailedResultSample	string	O exemplo de uma resposta de erro.	{"success": false}
Script	string	O script SQL.	select a from t
ScriptErrorCodes	array<object>	A lista de códigos de erro para a API de script.
	object
ErrorMessage	string	A mensagem de erro.	fail to call
ErrorCode	string	O código de erro.	1001
ErrorSolution	string	A solução para o erro.	retry
ScriptRequestParameters	array<object>	A lista de parâmetros de solicitação para a API de script.
	object
ParameterName	string	O nome do parâmetro.	param1
ParameterPosition	integer	A posição do parâmetro. Valores válidos: 0: Path 1: Query 2: Head 3: Body As APIs de assistente e de script suportam apenas Query. Para APIs de registro, os métodos GET e DELETE suportam Query e Head, e os métodos PUT e POST suportam Query, Head e Body.	0
ParameterDescription	string	A descrição.	description1
DefaultValue	string	O valor padrão.	default1
ParameterOperator	integer	O operador. Valores válidos: 0: Equal 1: Like 2: Const 3: In As APIs de assistente suportam Equal, Like e In. As APIs de script suportam Equal. As APIs de registro suportam Equal e Const.	0
ExampleValue	string	O valor de exemplo.	example1
ParameterDataType	integer	O tipo de dados. Valores válidos: 0: String 1: Int 2: Long 3: Float 4: Double 5: Boolean Scripts avançados também suportam os seguintes tipos de dados: 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>	A lista de parâmetros de resposta para a API de script.
	object
ParameterDescription	string	A descrição.	description2
ParameterName	string	O nome do parâmetro.	param2
ExampleValue	string	O valor de exemplo.	example2
ParameterDataType	integer	O tipo de dados. 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	A configuração da fonte de dados para a API de script.
TableName	string	O nome da tabela da fonte de dados.	t
ConnectionId	integer	O ID da fonte de dados.	123
WizardDetails	object	Os detalhes da API de assistente. Este parâmetro é retornado apenas para APIs de assistente.
IsPagedResponse	boolean	Indica se a resposta é paginada.	true
SuccessfulResultSample	string	O exemplo de uma resposta bem-sucedida.	{"success": true}
FailedResultSample	string	O exemplo de uma resposta de erro.	{"success": false}
WizardErrorCodes	array<object>	A lista de códigos de erro da API do assistente.
	object
ErrorMessage	string	A mensagem de erro.	fail to call
ErrorCode	string	O código de erro.	1001
ErrorSolution	string	A solução para o erro.	retry
WizardRequestParameters	array<object>	A lista de parâmetros de solicitação da API do assistente.
	object
ParameterName	string	O nome do parâmetro.	param1
ParameterPosition	integer	A posição do parâmetro. Valores válidos: 0 (Path), 1 (Query), 2 (Head) e 3 (Body). As APIs do assistente e de script suportam apenas Query. Para APIs registradas, os métodos GET e DELETE suportam Query e Head, e os métodos PUT e POST suportam Query, Head e Body.	0
ParameterDescription	string	A descrição.	description1
DefaultValue	string	O valor padrão.	default1
ParameterOperator	integer	O operador. Valores válidos: 0 (Equal), 1 (Like), 2 (Const) e 3 (In). As APIs do modo assistente suportam Equal, Like e In. As APIs do modo script suportam Equal. As APIs registradas suportam Equal e Const.	0
ExampleValue	string	O valor de exemplo.	example1
ParameterDataType	integer	O tipo de dados. 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>	A lista de parâmetros de resposta da API do assistente.
	object
ParameterDescription	string	A descrição.	description2
ParameterName	string	O nome do parâmetro.	param2
ExampleValue	string	O valor de exemplo.	example2
ParameterDataType	integer	O tipo de dados. 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 do assistente.
TableName	string	O nome da tabela da fonte de dados.	t
ConnectionId	integer	O ID da fonte de dados.	12354
SqlMode	integer	O modo SQL. Valores válidos: 0 (SQL básico) e 1 (SQL avançado).	0

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

Exemplos

Resposta de sucesso

JSON formato

{
  "HttpStatusCode": 200,
  "RequestId": "0000-ABCD-EFG****",
  "ErrorMessage": "A conexão não existe",
  "Success": true,
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 100,
    "Apis": [
      {
        "Timeout": 10000,
        "Status": 1,
        "ApiId": 10002,
        "ApiMode": 0,
        "ProjectId": 10000,
        "ResponseContentType": 0,
        "CreatorId": "1234567",
        "VisibleRange": 0,
        "ModifiedTime": "2020-06-23T00:21:01+0800",
        "OperatorId": "2345678",
        "GroupId": "ab123",
        "Description": "Descrição da API de teste",
        "RequestMethod": 0,
        "CreatedTime": "2020-06-23T00:21:01+0800",
        "ApiName": "Nome da minha 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": "falha ao chamar",
              "ErrorCode": "1001",
              "ErrorSolution": "tentar novamente"
            }
          ],
          "RegistrationRequestParameters": [
            {
              "ParameterName": "nome1",
              "ParameterPosition": 0,
              "ParameterDescription": "descrição1",
              "DefaultValue": "padrão1",
              "ParameterOperator": 0,
              "ExampleValue": "exemplo1",
              "ParameterDataType": 0,
              "IsRequiredParameter": true
            }
          ]
        },
        "ScriptDetails": {
          "IsPagedResponse": true,
          "SuccessfulResultSample": "{\"success\": true}",
          "FailedResultSample": "{\"success\": false}",
          "Script": "select a from t",
          "ScriptErrorCodes": [
            {
              "ErrorMessage": "falha ao chamar",
              "ErrorCode": "1001",
              "ErrorSolution": "tentar novamente"
            }
          ],
          "ScriptRequestParameters": [
            {
              "ParameterName": "param1",
              "ParameterPosition": 0,
              "ParameterDescription": "descrição1",
              "DefaultValue": "padrão1",
              "ParameterOperator": 0,
              "ExampleValue": "exemplo1",
              "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": "falha ao chamar",
              "ErrorCode": "1001",
              "ErrorSolution": "tentar novamente"
            }
          ],
          "WizardRequestParameters": [
            {
              "ParameterName": "param1",
              "ParameterPosition": 0,
              "ParameterDescription": "descrição1",
              "DefaultValue": "padrão1",
              "ParameterOperator": 0,
              "ExampleValue": "exemplo1",
              "ParameterDataType": 0,
              "IsRequiredParameter": true
            }
          ],
          "WizardResponseParameters": [
            {
              "ParameterDescription": "description2",
              "ParameterName": "param2",
              "ExampleValue": "example2",
              "ParameterDataType": 0
            }
          ],
          "WizardConnection": {
            "TableName": "t",
            "ConnectionId": 12354
          }
        },
        "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.	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.