DescribeJobMonitorRule - Data Transmission Service: 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	DescribeJobMonitorRule	Operação a ser executada. Defina o valor como DescribeJobMonitorRule.
DtsJobId	String	Sim	ta7w132u12h****	ID da tarefa de migração de dados, sincronização de dados ou rastreamento de alterações. Chame a operação DescribeDtsJobs para consultar o ID da tarefa.
RegionId	String	Não	cn-shenzhen	ID da região da instância do DTS. Para mais informações, consulte Regiões suportadas.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
HttpStatusCode	Integer	200	Código de status HTTP.
RequestId	String	0CA14388-DD89-4A7B-8CDD-884A10CE****	ID da solicitação.
DtsJobId	String	ta7w132u12h****	ID da tarefa de migração de dados, sincronização de dados ou rastreamento de alterações.
ErrCode	String	403	Código de erro retornado em caso de falha na solicitação.
Success	Boolean	true	Indica se a solicitação foi bem-sucedida. Valores válidos: true false
ErrMessage	String	The Value of Input Parameter %s is not valid.	Mensagem de erro retornada em caso de falha na solicitação.
Code	String	200	Código de resposta. Este parâmetro será removido futuramente.
DynamicMessage	String	DtsJobId	Parte dinâmica da mensagem de erro. Este parâmetro substitui a variável %s no valor de ErrMessage. Nota Por exemplo, se o valor retornado de ErrMessage for The Value of Input Parameter %s is not valid e o valor retornado de DynamicMessage for DtsJobId, o valor especificado para DtsJobId é inválido.
MonitorRules	Array of MonitorRule		Regras de alerta da tarefa do DTS.
Type	String	delay	Tipo da regra de alerta. Valores válidos: delay: dispara um alerta quando a latência da tarefa excede o limiar especificado. error: dispara um alerta ao ocorrer uma exceção. full_timeout: dispara um alerta quando a duração do módulo de migração ou sincronização completa de dados excede o limiar especificado. warn: dispara um alerta quando a tarefa é concluída, mas o resultado não corresponde ao esperado.
DelayRuleTime	Long	60	Limiar para disparar um alerta. Unidade: segundos.
State	String	Y	Indica se a regra de alerta está ativada. Valores válidos: Y: regra de alerta ativada. N: regra de alerta desativada.
Phone	String	1361234**,1371234**	Números de celular que recebem notificações de alerta. Separe vários números por vírgulas (,).
JobType	String	normal	Tipo da tarefa do DTS. Valores válidos: normal: tarefa de migração ou sincronização de dados. full_check: tarefa associada de verificação completa de dados. etl_check: tarefa associada de verificação incremental de dados.
Period	Integer	5	Período estatístico da tarefa de verificação incremental de dados. Unidade: minutos. Nota Valores válidos: 1, 5, 10 e 30.
Times	Integer	2	Quantidade de períodos estatísticos da tarefa de verificação incremental de dados.
NoticeValue	Integer	2	Limiar de alerta.
JobId	String	bi6e22ay243****	ID da tarefa.
Topics	Array of String	['topic_zyjg_prd']	Tópicos no cluster Kafka usados para receber os dados sincronizados ou migrados.

Exemplos

Solicitações de exemplo

http(s)://dts.aliyuncs.com/?Action=DescribeJobMonitorRule
&DtsJobId=ta7w132u12h****
&<Common request parameters>

Respostas de sucesso de exemplo

Formato XML

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

<DescribeJobMonitorRuleResponse>
    <DtsJobId>y5il58kzo9n****</DtsJobId>
    <RequestId>90DB5FA4-8C53-5123-91A9-63A4CA42****</RequestId>
    <HttpStatusCode>200</HttpStatusCode>
    <MonitorRules>
        <Type>delay</Type>
        <JobType>normal</JobType>
        <State>N</State>
        <Phone>1361234****</Phone>
        <Times>0</Times>
        <Period>0</Period>
        <NoticeValue>0</NoticeValue>
        <DelayRuleTime>0</DelayRuleTime>
        <JobId>y5il58kzo9n****</JobId>
    </MonitorRules>
    <MonitorRules>
        <Type>full_timeout</Type>
        <JobType>normal</JobType>
        <State>Y</State>
        <Times>0</Times>
        <Period>0</Period>
        <NoticeValue>0</NoticeValue>
        <JobId>y5il58kzo9n****</JobId>
    </MonitorRules>
    <MonitorRules>
        <Type>error</Type>
        <JobType>normal</JobType>
        <State>N</State>
        <Phone>1361234****</Phone>
        <Times>0</Times>
        <Period>0</Period>
        <NoticeValue>0</NoticeValue>
        <JobId>y5il58kzo9n****</JobId>
    </MonitorRules>
    <MonitorRules>
        <Type>error</Type>
        <JobType>full_check</JobType>
        <State>Y</State>
        <Times>0</Times>
        <Period>0</Period>
        <NoticeValue>0</NoticeValue>
        <JobId>qm2g550ku9x****</JobId>
    </MonitorRules>
    <MonitorRules>
        <Type>warn</Type>
        <JobType>full_check</JobType>
        <State>Y</State>
        <Times>0</Times>
        <Period>0</Period>
        <NoticeValue>1</NoticeValue>
        <JobId>qm2g550ku9x****</JobId>
    </MonitorRules>
    <MonitorRules>
        <Type>error</Type>
        <JobType>etl_check</JobType>
        <State>Y</State>
        <Times>0</Times>
        <Period>0</Period>
        <NoticeValue>0</NoticeValue>
        <JobId>wrdx5a8pc93****</JobId>
    </MonitorRules>
    <MonitorRules>
        <Type>delay</Type>
        <JobType>etl_check</JobType>
        <State>Y</State>
        <Times>2</Times>
        <Period>3</Period>
        <NoticeValue>0</NoticeValue>
        <DelayRuleTime>60</DelayRuleTime>
        <JobId>wrdx5a8pc93****</JobId>
    </MonitorRules>
    <MonitorRules>
        <Type>warn</Type>
        <JobType>etl_check</JobType>
        <State>Y</State>
        <Times>2</Times>
        <Period>3</Period>
        <NoticeValue>1</NoticeValue>
        <JobId>wrdx5a8pc93****</JobId>
    </MonitorRules>
    <Success>true</Success>
</DescribeJobMonitorRuleResponse>

Formato JSON

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

{
  "DtsJobId" : "y5il58kzo9n****",
  "Topics" : [ ],
  "RequestId" : "90DB5FA4-8C53-5123-91A9-63A4CA42****",
  "HttpStatusCode" : 200,
  "MonitorRules" : [ {
    "Type" : "delay",
    "JobType" : "normal",
    "State" : "N",
    "Phone" : "1361234****",
    "Times" : 0,
    "Period" : 0,
    "NoticeValue" : 0,
    "DelayRuleTime" : 0,
    "JobId" : "y5il58kzo9n****"
  }, {
    "Type" : "full_timeout",
    "JobType" : "normal",
    "State" : "Y",
    "Times" : 0,
    "Period" : 0,
    "NoticeValue" : 0,
    "JobId" : "y5il58kzo9n****"
  }, {
    "Type" : "error",
    "JobType" : "normal",
    "State" : "N",
    "Phone" : "1361234****",
    "Times" : 0,
    "Period" : 0,
    "NoticeValue" : 0,
    "JobId" : "y5il58kzo9n****"
  }, {
    "Type" : "error",
    "JobType" : "full_check",
    "State" : "Y",
    "Times" : 0,
    "Period" : 0,
    "NoticeValue" : 0,
    "JobId" : "qm2g550ku9x****"
  }, {
    "Type" : "warn",
    "JobType" : "full_check",
    "State" : "Y",
    "Times" : 0,
    "Period" : 0,
    "NoticeValue" : 1,
    "JobId" : "qm2g550ku9x****"
  }, {
    "Type" : "error",
    "JobType" : "etl_check",
    "State" : "Y",
    "Times" : 0,
    "Period" : 0,
    "NoticeValue" : 0,
    "JobId" : "wrdx5a8pc93****"
  }, {
    "Type" : "delay",
    "JobType" : "etl_check",
    "State" : "Y",
    "Times" : 2,
    "Period" : 3,
    "NoticeValue" : 0,
    "DelayRuleTime" : 60,
    "JobId" : "wrdx5a8pc93****"
  }, {
    "Type" : "warn",
    "JobType" : "etl_check",
    "State" : "Y",
    "Times" : 2,
    "Period" : 3,
    "NoticeValue" : 1,
    "JobId" : "wrdx5a8pc93****"
  } ],
  "Success" : true
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	Throttling.User	Request was denied due to user flow control.	O número de solicitações excedeu o limite superior e a solicitação foi rejeitada. Tente novamente mais tarde.
500	ServiceUnavailable	The request has failed due to a temporary failure of the server.	A resposta do servidor expirou ou o servidor estava indisponível. Tente novamente. Se o erro persistir, entre em contato com o suporte técnico.
403	InvalidSecurityToken.Expired	Specified SecurityToken is expired.	A assinatura expirou. Use uma nova assinatura.

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