Todos os produtos
Search

Este produto

    ApsaraMQ for RocketMQ:OnsInstanceBaseInfo

    Central de documentação

    ApsaraMQ for RocketMQ:OnsInstanceBaseInfo

    Última atualização: Jun 28, 2026

    Consulta as informações básicas de uma instância e seus endpoints para envio e recebimento de mensagens.

    Descrição da operação

    Importante

    A OpenAPI fornecida pela Alibaba Cloud é uma API de gerenciamento usada para gerenciar e consultar recursos de serviço da Alibaba Cloud. Integre a OpenAPI apenas para fins de gerenciamento. Não use a OpenAPI para links de dados principais que enviam e recebem mensagens. Isso pode criar riscos à segurança dos seus links de dados.

    Os clientes se conectam ao ApsaraMQ for RocketMQ por meio de endpoints para enviar e receber mensagens. Você pode chamar esta operação para consultar os endpoints de uma instâ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

    A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

    • Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.

    • API: A API que você pode chamar para executar a ação.

    • Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.

    • Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.

      • Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.

      • Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.

    • Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.

    • Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

    Ação

    Nível de acesso

    Tipo de recurso

    Chave de condição

    Ação dependente

    mq:QueryInstanceBaseInfo

    get

    *Instance

    acs:mq:{#regionId}:{#accountId}:{#InstanceId}

    		 Nenhuma Nenhuma

    Parâmetros da solicitação

    Parâmetro

    Tipo

    Obrigatório

    Descrição

    Exemplo
    InstanceId

    string

    Sim

    O ID da instância a ser consultada.

    MQ_INST_138015630679****_BAAy1Hac

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    InstanceBaseInfo

    object

    O objeto de informações da instância.

    Endpoints

    object

    Os endpoints para diferentes protocolos.

    TcpEndpoint

    string

    The internal endpoint for the TCP protocol.

    http://MQ_INST_138015630679****_BAAy1Hac.cn-chengdu.mq-internal.aliyuncs.com:8080
    TcpInternetEndpoint

    string

    The public endpoint for the TCP protocol.

    • Only instances in the China (Chengdu), China (Qingdao), and China (Shenzhen) regions support public endpoints for the TCP protocol.

    • To use the public endpoint for the TCP protocol, upgrade the client software development kit (SDK) to one of the following versions:

    • Data transfer costs are incurred when you use the public endpoint for the TCP protocol. For more information, see Data transfer cost.

    http://MQ_INST_138015630679****_BAAy1Hac.mq.cn-chengdu.aliyuncs.com:80
    HttpInternetEndpoint

    string

    The public endpoint for the HTTP protocol.

    http://138015630679****.mqrest.cn-chengdu.aliyuncs.com
    HttpInternalEndpoint

    string

    The internal endpoint for the HTTP protocol.

    http://138015630679****.mqrest.cn-chengdu-internal.aliyuncs.com
    HttpInternetSecureEndpoint

    string

    The public endpoint for the HTTPS protocol.

    https://138015630679****.mqrest.cn-chengdu.aliyuncs.com
    IndependentNaming

    boolean

    Indica se a instância possui um namespace. Valores válidos:

    • true: A instância possui um namespace independente. Os nomes dos recursos devem ser exclusivos dentro da instância. Os nomes dos recursos podem ser iguais entre instâncias.

    • false: A instância não possui um namespace independente. Os nomes dos recursos devem ser globalmente exclusivos.

    true
    MaxTps

    integer

    O número máximo de transações por segundo (TPS) para envio e recebimento de mensagens. Valores válidos: 5000, 10000, 20000, 50000, 100000, 200000, 300000, 500000, 800000 e 1000000.

    Para mais informações, consulte a página de compra de instâncias.

    Nota

    Este parâmetro é aplicável apenas a instâncias do ApsaraMQ for RocketMQ Platinum Edition.

    10000
    Remark

    string

    As observações da instância.

    ons-cn-m7r1r5f****
    InstanceName

    string

    O nome da instância.

    O nome deve ter de 3 a 64 caracteres e pode conter letras, dígitos, hifens (-) e sublinhados (_).

    test
    ReleaseTime

    integer

    A hora em que a instância da edição Platinum expira.

    1603555200000
    TopicCapacity

    integer

    O número máximo de tópicos que podem ser criados na instância. Valores válidos: 25, 50, 100, 300 e 500.

    Nota

    Este parâmetro é aplicável apenas a instâncias do ApsaraMQ for RocketMQ Platinum Edition.

    50
    InstanceStatus

    integer

    O status da instância. Valores válidos:

    • 0: A instância da edição Platinum está sendo implantada.

    • 2: O pagamento da instância da edição Standard está em atraso.

    • 5: A instância da edição Standard ou Platinum está em operação.

    • 7: A instância da edição Platinum está sendo atualizada e está disponível.

    5
    InstanceId

    string

    O ID da instância.

    MQ_INST_138015630679****_BAAy1Hac
    InstanceType

    integer

    O tipo da instância. Valores válidos:

    • 1: Instância da edição Standard (pago conforme o uso)

    • 2: Instância da edição Platinum (assinatura)

    Para mais informações sobre os tipos e especificações das instâncias do ApsaraMQ for RocketMQ, consulte Tipos de instância.

    2
    CreateTime

    string

    A hora em que a instância foi criada. O valor deste parâmetro é um timestamp UNIX em milissegundos.

    1570701259403
    spInstanceId

    string

    O ID do produto da instância.

    ons-cn-m7r1r5f****
    spInstanceType

    integer

    O modelo de cobrança da instância.

    Valores válidos:

    • 1 :

      Instância da edição Standard (pago conforme o uso)

    • 2 :

      Instância da edição Platinum (assinatura)

    1
    SupportClassic

    integer

    2
    RequestId

    string

    O parâmetro comum. Cada solicitação possui um ID exclusivo que você pode usar para solucionar problemas.

    6CC46974-65E8-4C20-AB07-D20D102E****

    Exemplos

    Resposta de sucesso

    JSON formato

    {
  "InstanceBaseInfo": {
    "Endpoints": {
      "TcpEndpoint": "http://MQ_INST_138015630679****_BAAy1Hac.cn-chengdu.mq-internal.aliyuncs.com:8080",
      "TcpInternetEndpoint": "http://MQ_INST_138015630679****_BAAy1Hac.mq.cn-chengdu.aliyuncs.com:80",
      "HttpInternetEndpoint": "http://138015630679****.mqrest.cn-chengdu.aliyuncs.com",
      "HttpInternalEndpoint": "http://138015630679****.mqrest.cn-chengdu-internal.aliyuncs.com",
      "HttpInternetSecureEndpoint": "https://138015630679****.mqrest.cn-chengdu.aliyuncs.com"
    },
    "IndependentNaming": true,
    "MaxTps": 10000,
    "Remark": "ons-cn-m7r1r5f****",
    "InstanceName": "test",
    "ReleaseTime": 1603555200000,
    "TopicCapacity": 50,
    "InstanceStatus": 5,
    "InstanceId": "MQ_INST_138015630679****_BAAy1Hac",
    "InstanceType": 2,
    "CreateTime": "1570701259403",
    "spInstanceId": "ons-cn-m7r1r5f****",
    "spInstanceType": 1,
    "SupportClassic": 2
  },
  "RequestId": "6CC46974-65E8-4C20-AB07-D20D102E****"
}

    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.