Todos os produtos
Search
Central de documentação

Resource Orchestration Service:DATASOURCE::KAFKA::Instance

Última atualização: Jun 27, 2026

Consulta informações sobre uma instância do ApsaraMQ for Kafka.

Sintaxe

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

Propriedades

Propriedade

Tipo

Obrigatória

Editável

Descrição

Restrição

InstanceId

String

Sim

Sim

ID da instância.

Nenhuma.

RefreshOptions

String

Não

Sim

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

Valores válidos:

  • Never (padrão): não atualiza os recursos da fonte de dados durante a atualização da pilha.

  • Always: atualiza os recursos da fonte de dados durante a atualização da pilha.

Valores de retorno

Fn::GetAtt

  • DeployType: tipo de implantação.

  • ResourceGroupId: ID do grupo de recursos.

  • SpecType: edição da instância.

  • IoMax: pico de tráfego.

  • AllConfig: configurações da instância implantada.

  • EndPoint: endpoint padrão no modo de endereço IP.

  • SaslDomainEndpoint: endpoint SASL (Simple Authentication and Security Layer) no modo de nome de domínio.

  • DiskType: tipo de disco.

  • SslDomainEndpoint: endpoint SSL no modo de nome de domínio.

  • AllowedList: lista de permissões de endereços IP.

  • MsgRetain: período de retenção de mensagens.

  • ExpiredTime: hora de expiração.

  • DiskSize: tamanho do disco.

  • PaymentType: método de faturamento da instância.

  • TopicNumLimit: número máximo de tópicos.

  • Tags: tags.

  • SslEndPoint: endpoint SSL no modo de endereço IP.

  • EipMax: pico de tráfego de Internet.

  • ZoneId: ID da zona.

  • InstanceId: ID da instância.

  • VSwitchId: ID do vSwitch.

  • CreateTime: hora de criação da instância.

  • InstanceName: nome da instância.

  • VpcId: ID da VPC.

  • DomainEndpoint: endpoint padrão no modo de nome de domínio.

  • IoMaxSpec: especificação de tráfego.

  • ServiceVersion: versão da instância implantada.

Exemplos

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  InstanceId:
    Type: String
    Description:
      en: The ID of the instance.
    Required: true
    AssociationProperty: ALIYUN::Kafka::Instance::InstanceId
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::KAFKA::Instance
    Properties:
      InstanceId:
        Ref: InstanceId
Outputs:
  DeployType:
    Description: Deployment method.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DeployType
  ResourceGroupId:
    Description: The ID of the resource group.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ResourceGroupId
  SpecType:
    Description: Instance type.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SpecType
  IoMax:
    Description: Peak flow.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - IoMax
  AllConfig:
    Description: The current configuration of the deployed message queue Kafka version.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - AllConfig
  EndPoint:
    Description: Access point.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - EndPoint
  SaslDomainEndpoint:
    Description: The domain name access point of the SASL access point. The Kafka instance supports domain name access points and IP access points.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SaslDomainEndpoint
  DiskType:
    Description: Disk type.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DiskType
  SslDomainEndpoint:
    Description: The domain name of the SSL access point. The Kafka instance supports domain name access points and IP access points.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SslDomainEndpoint
  AllowedList:
    Description: White list.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - AllowedList
  MsgRetain:
    Description: Message save time.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - MsgRetain
  ExpiredTime:
    Description: Expiration time.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ExpiredTime
  DiskSize:
    Description: Disk size.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DiskSize
  PaymentType:
    Description: The paymen type of the resource.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - PaymentType
  TopicNumLimit:
    Description: Maximum number of topic creation.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - TopicNumLimit
  Tags:
    Description: The tag of the kafka console, which is used to group instance,topic, and consumption.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Tags
  SslEndPoint:
    Description: External access point.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SslEndPoint
  EipMax:
    Description: Peak public network traffic.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - EipMax
  ZoneId:
    Description: The ID of the zone in which the instance is deployed.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ZoneId
  InstanceId:
    Description: The ID of the instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - InstanceId
  VSwitchId:
    Description: Switch id.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - VSwitchId
  CreateTime:
    Description: Creation time.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CreateTime
  InstanceName:
    Description: Note name.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - InstanceName
  VpcId:
    Description: VpcId.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - VpcId
  DomainEndpoint:
    Description: The domain name access point of the default access point. The Kafka instance supports domain name access points and IP access points.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DomainEndpoint
  IoMaxSpec:
    Description: Flow specifications (recommended).
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - IoMaxSpec
  ServiceVersion:
    Description: The version of the Kafka version of the deployed Message Queue. The value is 0.10.2 or 2.2.0.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ServiceVersion
{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "InstanceId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the instance."
      },
      "Required": true,
      "AssociationProperty": "ALIYUN::Kafka::Instance::InstanceId"
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::KAFKA::Instance",
      "Properties": {
        "InstanceId": {
          "Ref": "InstanceId"
        }
      }
    }
  },
  "Outputs": {
    "DeployType": {
      "Description": "Deployment method.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DeployType"
        ]
      }
    },
    "ResourceGroupId": {
      "Description": "The ID of the resource group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ResourceGroupId"
        ]
      }
    },
    "SpecType": {
      "Description": "Instance type.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SpecType"
        ]
      }
    },
    "IoMax": {
      "Description": "Peak flow.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "IoMax"
        ]
      }
    },
    "AllConfig": {
      "Description": "The current configuration of the deployed message queue Kafka version.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "AllConfig"
        ]
      }
    },
    "EndPoint": {
      "Description": "Access point.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "EndPoint"
        ]
      }
    },
    "SaslDomainEndpoint": {
      "Description": "The domain name access point of the SASL access point. The Kafka instance supports domain name access points and IP access points.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SaslDomainEndpoint"
        ]
      }
    },
    "DiskType": {
      "Description": "Disk type.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DiskType"
        ]
      }
    },
    "SslDomainEndpoint": {
      "Description": "The domain name of the SSL access point. The Kafka instance supports domain name access points and IP access points.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SslDomainEndpoint"
        ]
      }
    },
    "AllowedList": {
      "Description": "White list.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "AllowedList"
        ]
      }
    },
    "MsgRetain": {
      "Description": "Message save time.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "MsgRetain"
        ]
      }
    },
    "ExpiredTime": {
      "Description": "Expiration time.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ExpiredTime"
        ]
      }
    },
    "DiskSize": {
      "Description": "Disk size.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DiskSize"
        ]
      }
    },
    "PaymentType": {
      "Description": "The paymen type of the resource.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PaymentType"
        ]
      }
    },
    "TopicNumLimit": {
      "Description": "Maximum number of topic creation.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "TopicNumLimit"
        ]
      }
    },
    "Tags": {
      "Description": "The tag of the kafka console, which is used to group instance,topic, and consumption.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Tags"
        ]
      }
    },
    "SslEndPoint": {
      "Description": "External access point.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SslEndPoint"
        ]
      }
    },
    "EipMax": {
      "Description": "Peak public network traffic.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "EipMax"
        ]
      }
    },
    "ZoneId": {
      "Description": "The ID of the zone in which the instance is deployed.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ZoneId"
        ]
      }
    },
    "InstanceId": {
      "Description": "The ID of the instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceId"
        ]
      }
    },
    "VSwitchId": {
      "Description": "Switch id.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VSwitchId"
        ]
      }
    },
    "CreateTime": {
      "Description": "Creation time.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreateTime"
        ]
      }
    },
    "InstanceName": {
      "Description": "Note name.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceName"
        ]
      }
    },
    "VpcId": {
      "Description": "VpcId.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VpcId"
        ]
      }
    },
    "DomainEndpoint": {
      "Description": "The domain name access point of the default access point. The Kafka instance supports domain name access points and IP access points.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DomainEndpoint"
        ]
      }
    },
    "IoMaxSpec": {
      "Description": "Flow specifications (recommended).",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "IoMaxSpec"
        ]
      }
    },
    "ServiceVersion": {
      "Description": "The version of the Kafka version of the deployed Message Queue. The value is 0.10.2 or 2.2.0.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ServiceVersion"
        ]
      }
    }
  }
}