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

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos que você chame esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	ListNodes	A operação a ser executada. Defina o valor como ListNodes.
Owner	String	Não	193379****	O ID do proprietário.
BizName	String	Não	test_bizName	O nome do fluxo de trabalho.
ProgramType	String	Não	ODPS_SQL	O tipo de nó. Chame a operação ListFileType para consultar o tipo.
PageNumber	Integer	Não	1	O número da página. Valores válidos: 1 a 100.
PageSize	Integer	Não	10	O número de entradas por página. Valores válidos: 1 a 100. Valor padrão: 10.
ProjectId	Long	Sim	1234	O ID do workspace.
ProjectEnv	String	Sim	PROD	O ambiente do workspace. Valores válidos: PROD e DEV.
NodeName	String	Não	liux_test_n****	O nome do nó.
SchedulerType	String	Não	NORMAL	O tipo de agendamento do nó. Valores válidos: NORMAL: O nó é acionado automaticamente. PAUSE: O nó está pausado. SKIP: O nó é uma execução simulada (dry-run). Nós desse tipo são iniciados conforme o agendamento, mas o sistema define o status como bem-sucedido assim que começam a ser executados.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
HttpStatusCode	Integer	200	O código de status HTTP.
RequestId	String	E6F0DBDD-5AD****	O ID da solicitação.
ErrorMessage	String	The connection does not exist.	A mensagem de erro.
ErrorCode	String	Invalid.Tenant.ConnectionNotExists	O código de erro.
Success	Boolean	true	Indica se a solicitação foi bem-sucedida.
Data	Object		A lista de nós.
PageNumber	Integer	1	O número da página.
PageSize	Integer	10	O número de entradas por página. Valores válidos: 1 a 100. Valor padrão: 10.
TotalCount	Integer	66	O número total de nós retornados.
Nodes	Array of Nodes		As informações sobre os nós.
SchedulerType	String	NORMAL	O tipo de agendamento do nó. Valores válidos: NORMAL: O nó é acionado automaticamente. PAUSE: O nó está pausado. SKIP: O nó é uma execução simulada (dry-run). Nós desse tipo são iniciados conforme o agendamento, mas o sistema define o status como bem-sucedido assim que começam a ser executados.
RepeatInterval	Long	60	O intervalo em que o nó é reexecutado após uma falha na execução.
Repeatability	Boolean	true	Indica se o nó pode ser reexecutado.
ProjectId	Long	33671	O ID do workspace.
ProgramType	String	ODPS_SQL	O tipo de nó.
Priority	Integer	1	A prioridade do nó. Valores válidos: 1, 3, 5, 7 e 8.
OwnerId	String	19337906836551	O ID do proprietário.
Connection	String	odps_source	A string de conexão.
ParamValues	String	a=b	Os parâmetros adicionais.
RelatedFlowId	Long	1231123	O ID do fluxo de trabalho associado.
DqcType	Integer	1	Indica se o nó está associado a uma regra de monitoramento no Data Quality. Valores válidos: 0 e 1. O valor 0 indica que o nó não está associado a nenhuma regra de monitoramento no Data Quality. O valor 1 indica que o nó possui associação com uma regra de monitoramento no Data Quality.
BaselineId	Long	123456	O ID da linha de base.
Description	String	test	A descrição do nó.
NodeName	String	liux_test_n****	O nome do nó.
ResGroupName	String	Shared resource group	O nome do grupo de recursos.
BusinessId	Long	123	O ID do fluxo de trabalho.
DqcDescription	String	[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\u003d$[yyyy-mm-dd-1]"}]	A tabela e a expressão de filtro de partição no Data Quality associadas ao nó.
CronExpress	String	00 00 00 ?	A expressão CRON.
NodeId	Long	1234	O ID do nó.
ResGroupIdentifier	String	group_123	O identificador do grupo de recursos.
FileType	Integer	10	O tipo de arquivo.

Exemplos

Exemplos de solicitações

http(s)://[Endpoint]/?Action=ListNodes
&Owner=193379****
&BizName=test_bizName
&ProgramType=ODPS_SQL
&PageNumber=1
&PageSize=10
&ProjectId=1234
&ProjectEnv=PROD
&NodeName=liux_test_n****
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

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

<ListNodesResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <RequestId>E6F0DBDD-5AD****</RequestId>
    <ErrorMessage>The connection does not exist.</ErrorMessage>
    <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>
    <Success>true</Success>
    <Data>
        <PageNumber>1</PageNumber>
        <PageSize>10</PageSize>
        <TotalCount>66</TotalCount>
        <Nodes>
            <SchedulerType>NORMAL</SchedulerType>
            <RepeatInterval>60</RepeatInterval>
            <Repeatability>true</Repeatability>
            <ProjectId>33671</ProjectId>
            <ProgramType>ODPS_SQL</ProgramType>
            <Priority>1</Priority>
            <OwnerId>19337906836551</OwnerId>
            <Connection>odps_source</Connection>
            <ParamValues>a=b</ParamValues>
            <RelatedFlowId>1231123</RelatedFlowId>
            <DqcType>1</DqcType>
            <BaselineId>123456</BaselineId>
            <Description>test</Description>
            <NodeName>liux_test_n****</NodeName>
            <ResGroupName>Shared resource group</ResGroupName>
            <BusinessId>123</BusinessId>
            <DqcDescription>[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\u003d$[yyyy-mm-dd-1]"}]</DqcDescription>
            <CronExpress>00 00 00 * * ?</CronExpress>
            <NodeId>1234</NodeId>
            <ResGroupIdentifier>group_123</ResGroupIdentifier>
            <FileType>10</FileType>
        </Nodes>
    </Data>
</ListNodesResponse>

Formato JSON

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

{
  "HttpStatusCode" : 200,
  "RequestId" : "E6F0DBDD-5AD****",
  "ErrorMessage" : "The connection does not exist.",
  "ErrorCode" : "Invalid.Tenant.ConnectionNotExists",
  "Success" : true,
  "Data" : {
    "PageNumber" : 1,
    "PageSize" : 10,
    "TotalCount" : 66,
    "Nodes" : [ {
      "SchedulerType" : "NORMAL",
      "RepeatInterval" : 60,
      "Repeatability" : true,
      "ProjectId" : 33671,
      "ProgramType" : "ODPS_SQL",
      "Priority" : 1,
      "OwnerId" : "19337906836551",
      "Connection" : "odps_source",
      "ParamValues" : "a=b",
      "RelatedFlowId" : 1231123,
      "DqcType" : 1,
      "BaselineId" : 123456,
      "Description" : "test",
      "NodeName" : "liux_test_n****",
      "ResGroupName" : "Shared resource group",
      "BusinessId" : 123,
      "DqcDescription" : "[{\"projectName\":\"ztjy_dim\",\"tableName\":\"dim_user_agent_manage_area_a\",\"partition\":\"ds\\u003d$[yyyy-mm-dd-1]\"}]",
      "CronExpress" : "00 00 00 * * ?",
      "NodeId" : 1234,
      "ResGroupIdentifier" : "group_123",
      "FileType" : 10
    } ]
  }
}

Códigos de erro

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