Todos os produtos
Search
Central de documentação

DataWorks:GetBaseline

Última atualização: Oct 20, 2026

Obtém a configuração da linha de base pelo ID da linha de base.

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

BaselineId

integer

Sim

O ID da linha de base. Você pode chamar a operação ListBaselines para obter o ID.

123456

ProjectId

integer

Sim

O ID do espaço de trabalho monitorado pela linha de base. Você pode chamar a operação ListBaselines para obter o ID.

10000

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

OpenApiResultModel

Data

object

Os dados retornados.

AlertEnabled

boolean

Especifica se os alertas estão ativados. Valores válidos:

  • true: Ativado.

  • false: Desativado.

true

AlertMarginThreshold

integer

O limite de margem de alerta, em minutos.

60

AlertSettings

array<object>

As configurações de alerta.

array<object>

A configuração de alerta da linha de base.

AlertInterval

integer

O intervalo de alerta de evento, em segundos.

900

AlertMaximum

integer

O número máximo de alertas de evento.

1

AlertMethods

array

A lista de métodos de alerta.

string

O método de alerta. Valores válidos:

  • MAIL: E-mail.

  • SMS: Mensagem de texto.

  • PHONE: Chamada de voz.

  • DINGROBOTS: Chatbot do DingTalk.

  • WEBHOOKS: Webhook.

MAIL

AlertRecipient

string

Os detalhes do destinatário do alerta.

  • Se AlertRecipientType estiver definido como OWNER, este parâmetro será deixado vazio.

  • Se AlertRecipientType estiver definido como SHIFT_SCHEDULE, o valor será o UID da escala de plantão.

  • Se AlertRecipientType estiver definido como OTHER, o valor será uma lista de UIDs. Vários UIDs são separados por vírgulas (,).

123123

AlertRecipientType

string

O tipo de destinatário do alerta. Valores válidos:

  • OWNER: O proprietário do nó.

  • OTHER: Usuários especificados.

  • SHIFT_SCHEDULE: Escala de plantão.

OWNER

AlertType

string

O tipo de alerta. Valores válidos:

  • BASELINE: Linha de base.

  • TOPIC: Evento.

BASELINE

BaselineAlertEnabled

boolean

Especifica se os alertas de linha de base estão ativados. Esta é uma configuração específica da linha de base. Valores válidos:

  • true: Ativado.

  • false: Desativado.

false

DingRobots

array<object>

A lista de chatbots do DingTalk.

object

A configuração do chatbot do DingTalk.

AtAll

boolean

Especifica se deve usar @all.

true

WebUrl

string

A URL do webhook do chatbot do DingTalk.

https://oapi.dingtalk.com/robot/send?access_token=xxx

SilenceEndTime

string

A hora de término do período de silêncio, no formato HH:mm:ss.

00:00:00

SilenceStartTime

string

A hora de início do período de silêncio, no formato HH:mm:ss.

00:00:00

TopicSlowConfig

object

A configuração de limite para alertas de eventos lentos.

MinOver

integer

O limite mínimo para eventos lentos, em segundos. Valores válidos: 300 a 18000.

3600

OverFactor

number

A proporção usada para calcular o limite de eventos lentos com base na duração média histórica de execução do nó. Valores válidos: 0,1 a 2.

0.2

TopicTypes

array

A lista de tipos de alerta de evento. Esta é uma configuração específica de evento.

string

O tipo de alerta de evento. Valores válidos:

  • SLOW: Lento.

  • ERROR: Erro.

SLOW

Webhooks

array

A lista de webhooks.

string

A URL do webhook do chatbot do WeCom ou Lark. Várias URLs de webhook são separadas por vírgulas (,). O parâmetro alertMethods deve incluir WEBHOOKS. Este parâmetro é compatível apenas com o DataWorks Enterprise Edition.

Regiões compatíveis: China (Shanghai), China (Chengdu), China (Zhangjiakou), China (Beijing), China (Hangzhou), China (Shenzhen), China (Hong Kong), Alemanha (Frankfurt) e Cingapura.

https://open.feishu.cn/open-apis/bot/v2/hook/xxx

BaselineId

integer

O ID da linha de base.

1001

BaselineName

string

O nome da linha de base.

Test baseline

BaselineType

string

O tipo da linha de base. Valores válidos:

  • DAILY: Linha de base diária.

  • HOURLY: Linha de base horária.

DAILY

Enabled

boolean

Especifica se a linha de base está ativada.

true

NodeIds

array

A lista de nós upstream da linha de base.

integer

O ID do nó.

700003****

OverTimeSettings

array<object>

As configurações de tempo de compromisso da linha de base.

object

O período de monitoramento.

Cycle

integer

O ciclo correspondente ao tempo de compromisso. O valor é 1 para uma linha de base diária. Para uma linha de base horária, você pode configurar até 24 ciclos.

1

Time

string

O tempo de compromisso, no formato hh:mm. Valores válidos para hh: 0 a 47. Valores válidos para mm: 0 a 59.

00:00

Owner

string

O proprietário.

9527952****

Priority

integer

A prioridade da linha de base. Valores válidos: 1, 3, 5, 7 e 8.

1

ProjectId

integer

O ID do espaço de trabalho.

10000

ErrorCode

string

O código de erro.

1031203110005

ErrorMessage

string

A mensagem de erro.

The specified parameters are invalid

HttpStatusCode

integer

O código de status HTTP.

200

RequestId

string

O ID da solicitação.

ecb967ec-c137-48a5-860****

Success

boolean

Especifica se a solicitação foi bem-sucedida. Valores válidos:

  • true: Bem-sucedida.

  • false: Falhou.

true

Exemplos

Resposta de sucesso

JSON formato

{
  "Data": {
    "AlertEnabled": true,
    "AlertMarginThreshold": 60,
    "AlertSettings": [
      {
        "AlertInterval": 900,
        "AlertMaximum": 1,
        "AlertMethods": [
          "MAIL"
        ],
        "AlertRecipient": "123123",
        "AlertRecipientType": "OWNER",
        "AlertType": "BASELINE",
        "BaselineAlertEnabled": false,
        "DingRobots": [
          {
            "AtAll": true,
            "WebUrl": "https://oapi.dingtalk.com/robot/send?access_token=xxx"
          }
        ],
        "SilenceEndTime": "00:00:00",
        "SilenceStartTime": "00:00:00",
        "TopicSlowConfig": {
          "MinOver": 3600,
          "OverFactor": 0.2
        },
        "TopicTypes": [
          "SLOW"
        ],
        "Webhooks": [
          "https://open.feishu.cn/open-apis/bot/v2/hook/xxx"
        ]
      }
    ],
    "BaselineId": 1001,
    "BaselineName": "Test baseline",
    "BaselineType": "DAILY",
    "Enabled": true,
    "NodeIds": [
      0
    ],
    "OverTimeSettings": [
      {
        "Cycle": 1,
        "Time": "00:00"
      }
    ],
    "Owner": "9527952****",
    "Priority": 1,
    "ProjectId": 10000
  },
  "ErrorCode": "1031203110005",
  "ErrorMessage": "The specified parameters are invalid",
  "HttpStatusCode": 200,
  "RequestId": "ecb967ec-c137-48a5-860****",
  "Success": true
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.