Todos os produtos
Search
Central de documentação

DataWorks:GetCrawlerTypeCapabilities

Última atualização: Sep 03, 2026

Consulta os tipos de crawler suportados na região atual, juntamente com suas capacidades de escopo de coleta, agendamento e configuração de extensão.

Descrição da operação

Cenários

Consulta os tipos de crawler que podem ser criados na região atual, bem como as fontes de dados, o escopo de coleta, os grupos de recursos, o agendamento, a descrição de metadados por IA e as capacidades de configuração de extensão suportadas por cada tipo.

Fluxo de trabalho recomendado

  1. Chame esta operação antes de criar ou atualizar um crawler.

  2. Construa uma solicitação CreateCrawler ou UpdateCrawler com base nas informações de capacidade retornadas.

Requisitos de edição

É necessária a Edição Básica do DataWorks ou uma edição superior.

Precauções

As capacidades podem variar conforme a região e o tipo de crawler. Use a resposta real desta operação como referência.

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.

Sintaxe da solicitação

GET  HTTP/1.1

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

Nenhum parâmetro necessário.

Esta operação não requer parâmetros de solicitação de negócios.

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

A resposta.

RequestId

string

O ID da solicitação. Usado para localizar logs e solucionar problemas.

9252F32F-D855-549E-8898-61CF5A733050

Success

boolean

Indica se a solicitação foi bem-sucedida.

CrawlerTypes

array<object>

A lista de tipos de crawler e capacidades suportadas na região atual.

array<object>

As informações de capacidade de um único tipo de crawler.

Type

string

O tipo de crawler.

holo

DisplayName

string

O nome de exibição.

Hologres

SupportedEntityTypes

array<object>

Os níveis de entidade de metadados que o tipo de crawler suporta para coleta.

object

Um único nível de entidade de metadados.

Type

string

holo

SubType

string

database

Optional

boolean

ParentSubType

string

instance

SupportedScopeUnits

array

A lista de granularidades de escopo de coleta suportadas.

string

Uma única granularidade de escopo de coleta.

DATABASE

DefaultScopeUnit

string

A granularidade padrão do escopo de coleta.

DATABASE

SupportedOptionKeys

array<object>

Os itens de configuração de extensão de crawler suportados.

object

Um único item de configuração de extensão de crawler.

Key

string

CollectRecyclebin

ValueType

string

BOOLEAN

Required

boolean

DefaultValue

string

false

AllowedValues

array

string

true

SupportExcludeRegex

boolean

Indica se há suporte para expressões regulares de exclusão de esquema ou tabela.

SupportSchedule

boolean

Indica se há suporte para agendamento periódico.

SupportAiComment

boolean

Indica se há suporte para descrição de metadados por IA.

RequireResourceGroup

boolean

Indica se um grupo de recursos deve ser especificado ao criar este tipo de crawler.

SupportedDatasourceTypes

array

A lista de tipos de fonte de dados suportados.

string

Um único tipo de fonte de dados.

holo

CrawlerTypes contém apenas os tipos de crawler que podem ser criados na região atual.

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "9252F32F-D855-549E-8898-61CF5A733050",
  "Success": false,
  "CrawlerTypes": [
    {
      "Type": "holo",
      "DisplayName": "Hologres",
      "SupportedEntityTypes": [
        {
          "Type": "holo",
          "SubType": "database",
          "Optional": false,
          "ParentSubType": "instance"
        }
      ],
      "SupportedScopeUnits": [
        "DATABASE"
      ],
      "DefaultScopeUnit": "DATABASE",
      "SupportedOptionKeys": [
        {
          "Key": "CollectRecyclebin",
          "ValueType": "BOOLEAN",
          "Required": false,
          "DefaultValue": "false",
          "AllowedValues": [
            "true"
          ]
        }
      ],
      "SupportExcludeRegex": false,
      "SupportSchedule": false,
      "SupportAiComment": false,
      "RequireResourceGroup": false,
      "SupportedDatasourceTypes": [
        "holo"
      ]
    }
  ]
}

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.