Todos os produtos
Search
Central de documentação

Resource Orchestration Service:DATASOURCE::KAFKA::Topic

Última atualização: Jun 27, 2026

Consulta informações sobre um tópico do ApsaraMQ for Kafka.

Sintaxe

{
  "Type": "DATASOURCE::KAFKA::Topic",
  "Properties": {
    "InstanceId": String,
    "Topic": String,
    "RefreshOptions": String
  }
}

Propriedades

Propriedade

Tipo

Obrigatória

Editável

Descrição

Restrição

InstanceId

String

Sim

Sim

ID da instância à qual o tópico pertence.

Nenhuma.

Topic

String

Sim

Sim

Nome do tópico.

Nenhuma.

RefreshOptions

String

Não

Sim

Política de atualização dos recursos da source de dados durante a atualização da pilha.

Valores válidos:

  • Never (padrão): não atualiza os recursos da source de dados nas atualizações da pilha.

  • Always: atualiza os recursos da source de dados nas atualizações da pilha.

Valores de retorno

Fn::GetAtt

  • PartitionNum: número de partições do tópico.

  • CompactTopic: política de limpeza de log. Retornado apenas quando LocalTopic é defina como true.

  • InstanceId: ID da instância.

  • CreateTime: hora de criação do tópico, em milissegundos.

  • StatusName: status do serviço.

  • TopicStatus: status do tópico.

  • Topic: nome do tópico.

  • LocalTopic: mecanismo de armazenamento do tópico.

  • Tags: as tags.

  • Remark: observações.

Exemplos

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  InstanceId:
    Description:
      en: Resource id.
    Required: true
    Type: String
  Topic:
    Description:
      en: Topic Name.
    Required: true
    Type: String
Resources:
  ExtensionDataSource:
    Properties:
      InstanceId:
        Ref: InstanceId
      Topic:
        Ref: Topic
    Type: DATASOURCE::KAFKA::Topic
Outputs:
  CompactTopic:
    Description: Can log merge.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - CompactTopic
  CreateTime:
    Description: Creation time.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - CreateTime
  InstanceId:
    Description: Resource id.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - InstanceId
  LocalTopic:
    Description: Whether to store locally.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - LocalTopic
  PartitionNum:
    Description: Number of partitions.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - PartitionNum
  Remark:
    Description: Remarks.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Remark
  StatusName:
    Description: Meaning of status value.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - StatusName
  Tags:
    Description: The tag of the kafka console, which is used to group instance,topic,
      and consumption.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Tags
  Topic:
    Description: Topic Name.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Topic
  TopicStatus:
    Description: The Topic status.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - TopicStatus
                        
{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "InstanceId": {
      "Type": "String",
      "Description": {
        "en": "Resource id."
      },
      "Required": true
    },
    "Topic": {
      "Type": "String",
      "Description": {
        "en": "Topic Name."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::KAFKA::Topic",
      "Properties": {
        "InstanceId": {
          "Ref": "InstanceId"
        },
        "Topic": {
          "Ref": "Topic"
        }
      }
    }
  },
  "Outputs": {
    "PartitionNum": {
      "Description": "Number of partitions.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PartitionNum"
        ]
      }
    },
    "CompactTopic": {
      "Description": "Can log merge.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CompactTopic"
        ]
      }
    },
    "InstanceId": {
      "Description": "Resource id.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceId"
        ]
      }
    },
    "CreateTime": {
      "Description": "Creation time.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreateTime"
        ]
      }
    },
    "StatusName": {
      "Description": "Meaning of status value.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "StatusName"
        ]
      }
    },
    "TopicStatus": {
      "Description": "The Topic status.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "TopicStatus"
        ]
      }
    },
    "Topic": {
      "Description": "Topic Name.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Topic"
        ]
      }
    },
    "LocalTopic": {
      "Description": "Whether to store locally.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "LocalTopic"
        ]
      }
    },
    "Tags": {
      "Description": "The tag of the kafka console, which is used to group instance,topic, and consumption.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Tags"
        ]
      }
    },
    "Remark": {
      "Description": "Remarks.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Remark"
        ]
      }
    }
  }
}