ListBusiness - : Central de Documentação do Alibaba Cloud

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. A ferramenta também gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	ListBusiness	Operação a executar. Defina o valor como ListBusiness.
ProjectId	Long	Não	10000	ID do workspace do DataWorks. Faça login no console do DataWorks e acesse a página Work space para obter esse ID. Configure este parâmetro ou o parâmetro ProjectIdentifier para especificar o workspace do DataWorks alvo da operação.
ProjectIdentifier	String	Não	dw_project	Nome do workspace do DataWorks. Faça login no console do DataWorks e acesse a página Work space para obter esse nome. Configure este parâmetro ou o parâmetro ProjectId para especificar o workspace do DataWorks alvo da operação.
PageNumber	Integer	Sim	1	Número da página.
PageSize	Integer	Sim	10	Quantidade de entradas por página. Valores válidos: 1 a 100. Valor padrão: 10.
Keyword	String	Não	my	Palavra-chave nos nomes dos workflows para correspondência difusa.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
HttpStatusCode	Integer	200	Código de status HTTP.
ErrorMessage	String	The connection does not exist.	Mensagem de erro.
RequestId	String	0000-ABCD-EFG****	ID da solicitação.
ErrorCode	String	Invalid.Tenant.ConnectionNotExists	Código de erro.
Success	Boolean	true	Indica se a solicitação foi bem-sucedida.
Data	Object		Informações sobre os workflows retornados.
PageNumber	Integer	1	Número da página.
PageSize	Integer	10	Quantidade de entradas por página.
TotalCount	Integer	13	Total de entradas retornadas.
Business	Array of Business		Lista de workflows.
Owner	String	34824327****	Proprietário do workflow.
Description	String	My first workflow	Descrição do workflow.
ProjectId	Long	10000	ID do workspace ao qual o workflow pertence.
BusinessId	Long	3000001	ID do workflow.
BusinessName	String	My first workflow	Nome do workflow.
UseType	String	NORMAL	Módulo ao qual o workflow pertence. Valores válidos: NORMAL e MANUAL_BIZ. NORMAL indica workflows acionados automaticamente; MANUAL_BIZ indica workflows acionados manualmente.

Exemplos

Exemplos de solicitações

http(s)://[Endpoint]/?Action=ListBusiness
&ProjectId=10000
&ProjectIdentifier=dw_project
&PageNumber=1
&PageSize=10
&Keyword=my
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<ListBusinessResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <ErrorMessage>The connection does not exist.</ErrorMessage>
    <RequestId>0000-ABCD-EFG****</RequestId>
    <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>
    <Success>true</Success>
    <Data>
        <PageNumber>1</PageNumber>
        <PageSize>10</PageSize>
        <TotalCount>13</TotalCount>
        <Business>
            <Owner>34824327****</Owner>
            <Description>My first workflow</Description>
            <ProjectId>10000</ProjectId>
            <BusinessId>3000001</BusinessId>
            <BusinessName>My first workflow</BusinessName>
            <UseType>NORMAL</UseType>
        </Business>
    </Data>
</ListBusinessResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "HttpStatusCode" : 200,
  "ErrorMessage" : "The connection does not exist.",
  "RequestId" : "0000-ABCD-EFG****",
  "ErrorCode" : "Invalid.Tenant.ConnectionNotExists",
  "Success" : true,
  "Data" : {
    "PageNumber" : 1,
    "PageSize" : 10,
    "TotalCount" : 13,
    "Business" : [ {
      "Owner" : "34824327****",
      "Description" : "My first workflow",
      "ProjectId" : 10000,
      "BusinessId" : 3000001,
      "BusinessName" : "My first workflow",
      "UseType" : "NORMAL"
    } ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	Sem permissões.
429	Throttling.Api	The request for this resource has exceeded your available limit.	A quantidade de solicitações para o recurso excedeu o limite superior.
429	Throttling.System	The DataWorks system is busy. Try again later.	O sistema do DataWorks está ocupado. Tente novamente mais tarde.
429	Throttling.User	Your request is too frequent. Try again later.	Muitas solicitações foram enviadas em um curto período. Tente novamente mais tarde.
500	InternalError.System	An internal system error occurred. Try again later.	Ocorreu um erro interno. Tente novamente mais tarde.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.	Ocorreu um erro interno. Tente novamente mais tarde.

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.