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

Consulta uma lista de APIs de serviço de dados em desenvolvimento.

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. Você pode chamar a operação ListProjects para obter um ID de espaço de trabalho válido ou visualizá-lo nas configurações do espaço de trabalho no console do DataWorks. O valor de exemplo na documentação é apenas para fins de demonstração.	10000
TenantId	integer	Não	O ID do locatário. Para obter o ID do locatário, faça logon no console do DataWorks, acesse a página Data Studio, clique no nome de usuário no canto superior direito e escolha Menu > Informações do Usuário.	10001
ApiNameKeyword	string	Não	A palavra-chave no nome da API. Este parâmetro filtra as APIs cujos nomes contêm a palavra-chave especificada.	My API name
ApiPathKeyword	string	Não	A palavra-chave no caminho da API. Este parâmetro filtra as APIs cujos caminhos contêm a palavra-chave especificada.	/test/
CreatorId	string	Não	O ID da Alibaba Cloud do criador da API. Este parâmetro filtra as APIs criadas pelo usuário especificado.	123456

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O objeto de resposta.
HttpStatusCode	integer	O código de status HTTP.	200
RequestId	string	O ID da 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 sobre as APIs em desenvolvimento.
PageNumber	integer	O número da página, que é o mesmo que o parâmetro 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 entradas.	100
Apis	array<object>	A lista de APIs em desenvolvimento.
	array<object>	O objeto de resposta.
Timeout	integer	O período de tempo limite, em milissegundos.	10000
Status	integer	O status da API. Valores válidos: 0: Não publicada. 1: Publicada.	0
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 registrada.	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 registradas suportam JSON e XML.	0
CreatorId	string	O ID da Alibaba Cloud do criador.	1234567
VisibleRange	integer	O escopo de visibilidade. Valores válidos: 0: Espaço de trabalho. 1: Privado.	0
ModifiedTime	string	A hora da última modificação. O formato é `yyyy-MM-dd'T'HH:mm:ssZ`. 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 último editor.	2345678
GroupId	string	O ID do grupo.	abcde123456789
Description	string	A descrição da API.	Test API description
FolderId	integer	O ID da pasta.	0
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 registradas suportam GET, POST, PUT e DELETE.	0
CreatedTime	string	A hora de criação. O formato é `yyyy-MM-dd'T'HH:mm:ssZ`. 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.	10000
ApiPath	string	O caminho da API.	/test/1
Protocols	array	A lista de campos.
	integer	Os protocolos da API. Esta é uma lista de múltiplos valores. Valores válidos: 0: HTTP. 1: HTTPS.	0
RegistrationDetails	object	Os detalhes da API registrada. Isso é retornado apenas para APIs registradas.
ServiceHost	string	O endereço do serviço de back-end.	http://example.aliyundoc.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 registradas suportam JSON e XML.	0
ServicePath	string	O caminho do serviço de back-end.	/index
SuccessfulResultSample	string	A amostra de resposta de sucesso.	{"success": true}
FailedResultSample	string	A amostra de 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 registrada.
	object	O objeto de resposta.
ErrorMessage	string	A mensagem de erro.	fail to call
ErrorCode	string	O código de erro.	1001
ErrorSolution	string	As soluções para a falha.	retry
RegistrationRequestParameters	array<object>	A lista de parâmetros de solicitação para a API registrada.
	object	O objeto de resposta.
ColumnName	string	O nome do campo da tabela vinculada. Isso é suportado apenas no modo de assistente.	column1
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 registradas, os métodos GET e DELETE suportam Query e Head, enquanto os métodos PUT e POST suportam Query, Head e Body.	0
ParameterDescription	string	A descrição do parâmetro.	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 registradas suportam Equal e Const.	0
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
ExampleValue	string	O valor de exemplo.	example1
IsRequiredParameter	boolean	Indica se o parâmetro é obrigatório.	true
ScriptDetails	object	Os detalhes da API de script. Isso é retornado apenas para APIs de script.
Script	string	O script SQL.	select a from t
IsPagedResponse	boolean	Indica se a resposta é paginada.	true
ScriptRequestParameters	array<object>	A lista de parâmetros de solicitação para a API de script.
	object	O objeto de resposta.
ColumnName	string	O nome do campo da tabela vinculada. Isso é suportado apenas no modo de assistente.	column1
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 registradas, os métodos GET e DELETE suportam Query e Head, enquanto os métodos PUT e POST suportam Query, Head e Body.	0
ParameterDescription	string	A descrição do parâmetro.	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 registradas suportam Equal e Const.	0
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
ExampleValue	string	O valor de exemplo.	example1
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	O objeto de resposta.
ParameterDescription	string	A descrição do parâmetro.	description2
ColumnName	string	O nome do campo da tabela vinculada. Isso está disponível apenas no modo de assistente.	column2
ParameterName	string	O nome do parâmetro.	param2
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
ExampleValue	string	O valor de exemplo.	example2
ScriptConnection	object	As informações da fonte de dados da 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. Isso é retornado apenas para APIs de assistente.
IsPagedResponse	boolean	Indica se a resposta é paginada.	true
WizardRequestParameters	array<object>	Os parâmetros de solicitação da API do assistente.
	object	O objeto de resposta.
ColumnName	string	O nome do campo da tabela vinculada. Isso é suportado apenas no modo de assistente.	column1
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 registradas, os métodos GET e DELETE suportam Query e Head, enquanto 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 assistente suportam Equal, Like e In. As APIs de script suportam Equal. As APIs registradas suportam Equal e Const.	0
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
ExampleValue	string	O valor de exemplo.	example1
IsRequiredParameter	boolean	Indica se o parâmetro é obrigatório.	true
WizardResponseParameters	array<object>	Os parâmetros de resposta do modo assistente.
	object	O objeto de resposta.
ParameterDescription	string	A descrição.	description2
ColumnName	string	O nome do campo da tabela vinculada. Isso é suportado apenas no modo de assistente.	column2
ParameterName	string	O nome do parâmetro.	param2
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
ExampleValue	string	O valor de exemplo.	example2
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.	123

Os detalhes de diferentes tipos de APIs são retornados em campos diferentes. O campo WizardDetails é usado para APIs de assistente, o campo ScriptDetails é usado para APIs de script e o campo RegistrationDetails é usado para APIs de registro.

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": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 100,
    "Apis": [
      {
        "Timeout": 10000,
        "Status": 0,
        "ApiId": 10002,
        "ApiMode": 0,
        "ProjectId": 10000,
        "ResponseContentType": 0,
        "CreatorId": "1234567",
        "VisibleRange": 0,
        "ModifiedTime": "2020-06-23T00:21:01+0800",
        "OperatorId": "2345678",
        "GroupId": "abcde123456789",
        "Description": "Test API description",
        "FolderId": 0,
        "RequestMethod": 0,
        "CreatedTime": "2020-06-23T00:21:01+0800",
        "ApiName": "My API name",
        "TenantId": 10000,
        "ApiPath": "/test/1",
        "Protocols": [
          0
        ],
        "RegistrationDetails": {
          "ServiceHost": "http://example.aliyundoc.com",
          "ServiceContentType": 0,
          "ServicePath": "/index",
          "SuccessfulResultSample": "{\"success\": true}",
          "FailedResultSample": "{\"success\": false}",
          "ServiceRequestBodyDescription": "{\"abc\":1}",
          "RegistrationErrorCodes": [
            {
              "ErrorMessage": "fail to call",
              "ErrorCode": "1001",
              "ErrorSolution": "retry"
            }
          ],
          "RegistrationRequestParameters": [
            {
              "ColumnName": "column1",
              "ParameterName": "name1",
              "ParameterPosition": 0,
              "ParameterDescription": "description1",
              "DefaultValue": "default1",
              "ParameterOperator": 0,
              "ParameterDataType": 0,
              "ExampleValue": "example1",
              "IsRequiredParameter": true
            }
          ]
        },
        "ScriptDetails": {
          "Script": "select a from t",
          "IsPagedResponse": true,
          "ScriptRequestParameters": [
            {
              "ColumnName": "column1",
              "ParameterName": "param1",
              "ParameterPosition": 0,
              "ParameterDescription": "description1",
              "DefaultValue": "default1",
              "ParameterOperator": 0,
              "ParameterDataType": 0,
              "ExampleValue": "example1",
              "IsRequiredParameter": true
            }
          ],
          "ScriptResponseParameters": [
            {
              "ParameterDescription": "description2",
              "ColumnName": "column2",
              "ParameterName": "param2",
              "ParameterDataType": 0,
              "ExampleValue": "example2"
            }
          ],
          "ScriptConnection": {
            "TableName": "t",
            "ConnectionId": 123
          }
        },
        "WizardDetails": {
          "IsPagedResponse": true,
          "WizardRequestParameters": [
            {
              "ColumnName": "column1",
              "ParameterName": "param1",
              "ParameterPosition": 0,
              "ParameterDescription": "description1",
              "DefaultValue": "default1",
              "ParameterOperator": 0,
              "ParameterDataType": 0,
              "ExampleValue": "example1",
              "IsRequiredParameter": true
            }
          ],
          "WizardResponseParameters": [
            {
              "ParameterDescription": "description2",
              "ColumnName": "column2",
              "ParameterName": "param2",
              "ParameterDataType": 0,
              "ExampleValue": "example2"
            }
          ],
          "WizardConnection": {
            "TableName": "t",
            "ConnectionId": 123
          }
        }
      }
    ]
  }
}

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.