GetInstance - ApsaraMQ for RocketMQ: Central de Documentação do Alibaba Cloud

Obtém os detalhes de uma instância especificada.

Descrição da operação

Importante A OpenAPI fornecida pelo Alibaba Cloud é uma API de gerenciamento e controle usada para gerenciar e consultar recursos relacionados dos serviços do Alibaba Cloud. É recomendada apenas para integração em links de gerenciamento e controle. O uso da OpenAPI no link de dados principal para envio e recebimento de mensagens é estritamente proibido. Caso contrário, podem ocorrer riscos no link.

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

rocketmq:GetInstance

get

*Instance

acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}

Nenhuma

Sintaxe da solicitação

GET /instances/{instanceId} HTTP/1.1

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
instanceId	string	Sim	O ID da instância a ser consultada.	rmq-cn-7e22ody****

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

Nenhum parâmetro necessário.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os dados da resposta.
requestId	string	O ID da solicitação. Cada solicitação possui um ID exclusivo, que pode ser usado para solucionar problemas.	05AB7FBD-F1D3-5D87-BF78-BD782249****
success	boolean	Indica se a operação foi bem-sucedida.	true.
data	object	Os dados da resposta.
regionId	string	O ID da região da instância.	cn-hangzhou.
instanceId	string	O ID da instância.	rmq-cn-7e22ody****
instanceName	string	O nome da instância.	instância de teste.
status	string	O status da instância. Valores válidos: RELEASED : Liberada. RUNNING : Em execução. STOPPED : Parada. CHANGING : Sendo alterada. CREATING : Sendo criada.	RUNNING.
startTime	string	A hora de início da instância.	2022-08-01 00:00:00
expireTime	string	A hora de expiração da instância.	2022-09-01 00:00:00
releaseTime	string	A hora de liberação da instância.	2022-09-07 00:00:00
userId	string	O ID do usuário ao qual a instância pertence.	111111111111111
bid	string	O BID do canal de vendas da mercadoria.	26842
commodityCode	string	O código da mercadoria da instância de fila MSMQ for RocketMQ 5.x, como ons_rmqsub_public_cn.	ons_rmqsub_public_cn.
serviceCode	string	A codificação de serviço da instância. A codificação de serviço para fila MSMQ for RocketMQ é rmq.	rmq.
seriesCode	string	O código da série principal da instância. Para diferenças entre as séries principais, consulte Seleção de produtos. Valores válidos: standard : Edição Standard. shared : Edição Shared. dedicated : Edição Dedicated. ultimate : Edição Platinum. professional : Edição Professional.	standard.
subSeriesCode	string	O código da subsérie da instância. Para diferenças entre as subséries, consulte Seleção de produtos. Valores válidos: serverless : Edição Serverless. cluster_ha : Edição Cluster High-Availability. single_node : Edição Single-Node.	cluster_ha.
paymentType	string	O método de cobrança da instância. Valores válidos: PayAsYouGo : Pay-as-you-go (pós-pago). Subscription : Subscription (pré-pago).	Subscription.
remark	string	As observações da instância.	Esta é uma observação para a instância.
networkInfo	object	As informações de rede.
vpcInfo	object	As informações da VPC.
vpcId	string	O ID da VPC associada à instância.	vpc-uf6of9452b2pba82c****
vSwitchId `deprecated`	string	O ID do vSwitch associado à instância.	vsw-uf6gwtbn6etadpvz7****
vSwitches	array<object>	A lista de vSwitches.
	object
vSwitchId	string	O ID do vSwitch.	vsw-uf6gwtbn6etadpvz7****
zoneId	string	O ID da zona.	cn-hangzhou.
securityGroupIds	string	O ID do grupo de segurança.	sg-hp35r2hc3a3sv8q2sb16
endpoints	array<object>	As informações do endpoint.
	object	As informações do endpoint.
endpointType	string	O tipo de endpoint da instância. Valores válidos: TCP_VPC : Endpoint da VPC. TCP_INTERNET : Endpoint público.	TCP_INTERNET.
endpointUrl	string	O endpoint da instância.	rmq-cn-c4d2tbk****-vpc.cn-hangzhou.rmq.aliyuncs.com:8080
ipWhitelist	array	A lista de permissões de IP para acesso à rede pública. Apenas endpoints públicos suportam configuração de lista de permissões de IP. Endpoints da VPC não suportam esse recurso.	192.168.x.x/24
	string	A lista de permissões de IP para acesso à rede pública.	192.168.x.x/24
endpointId	string	A instância PVL EP associada.	ep-bpxxx.
internetInfo	object	As informações da rede pública da instância.
internetSpec	string	Especifica se o acesso à rede pública está ativado. Valores válidos: enable : Acesso à rede pública ativado. disable : Acesso à rede pública desativado.	enable.
flowOutType	string	O tipo de cobrança da rede pública. Valores válidos: payByBandwidth : Cobrança por largura de banda fixa. Defina este valor quando o acesso à rede pública estiver ativado. uninvolved : Não aplicável. Defina este valor quando o acesso à rede pública não estiver ativado.	payByBandwidth.
flowOutBandwidth	integer	A especificação de largura de banda da Internet. Unidade: 1 Mbit/s.	1
ipWhitelist	array	A lista de permissões de IP para acesso à rede pública.
	string	A lista de permissões de IP para acesso à rede pública.	192.168.x.x/24
accountInfo	object	As informações da conta.
username	string	O nome de usuário da instância. Ao usar o acesso à rede pública, configure o nome de usuário e a senha da instância no código do SDK para verificação de identidade e autenticação do cliente.	6W0xz2uPfiwp****
instanceQuotas	array<object>	As informações de capacidade.
	object	As informações de capacidade.
quotaName	string	O nome da cota da instância. Valores válidos: TOPIC_COUNT : Cota de criação de tópicos da instância.	TOPIC_COUNT.
usedCount	number	A contagem utilizada. Unidade: contagem.	10
freeCount	number	A cota livre. Unidade: contagem.	20
totalCount	number	A cota total. Unidade: contagem.	100
createTime	string	A hora de criação da instância.	2022-08-01 00:00:00
updateTime	string	A última hora de modificação da instância.	2022-08-02 00:00:00
extConfig `deprecated`	object	A configuração estendida. Este campo está obsoleto. Use os campos productInfo, internetInfo e aclInfo em vez disso.
aclType	string	O tipo de autenticação da instância. Valores válidos: default : Reconhecimento inteligente de identidade. apache_acl : ACL do Apache RocketMQ.	default.
sendReceiveRatio	number	A proporção de envio para recebimento de mensagens.	0.5
autoScaling	boolean	Especifica se a capacidade elástica expansível fora da especificação está ativada. Valores válidos: true : Capacidade elástica ativada. false : Capacidade elástica não ativada.	true.
messageRetentionTime	integer	O período de retenção de mensagens. Unidade: horas.	72
supportAutoScaling	boolean	Indica se a instância suporta capacidade elástica expansível fora da especificação. Valores válidos: true : Suporta ativação de capacidade elástica. false : Não suporta ativação de capacidade elástica.	true.
internetSpec	string	Especifica se o acesso à rede pública está ativado. Valores válidos: enable : Acesso à rede pública ativado. disable : Acesso à rede pública desativado.	enable.
flowOutType	string	O tipo de cobrança da rede pública. Valores válidos: payByTraffic : Pagamento por tráfego. payByBandwidth : Pagamento por largura de banda. uninvolved : Não aplicável.	payByBandwidth.
flowOutBandwidth	integer	A especificação de largura de banda da Internet. Unidade: Mbit/s.	10
msgProcessSpec	string	A especificação de computação de envio/recebimento de mensagens. Para os limites específicos de TPS, consulte Especificações da instância.	rmq.s2.2xlarge.
resourceGroupId	string	O ID do grupo de recursos.	rg-acfm3tmjruyribi.
productInfo	object	A configuração estendida da instância.
msgProcessSpec	string	A especificação de computação de envio/recebimento de mensagens. Para os limites específicos de TPS, consulte Especificações da instância.	rmq.s2.2xlarge.
sendReceiveRatio	number	A proporção de envio para recebimento de mensagens.	0.5
autoScaling	boolean	Especifica se a capacidade elástica expansível fora da especificação está ativada. Valores válidos: true : Capacidade elástica ativada. false : Capacidade elástica não ativada.	true.
messageRetentionTime	integer	O período de retenção de mensagens. Unidade: horas.	72
supportAutoScaling	boolean	Indica se a capacidade elástica expansível fora da especificação é suportada. Valores válidos: true : Suporta ativação de capacidade elástica. false : Não suporta ativação de capacidade elástica.	true.
traceOn	boolean	Indica se o recurso de rastreamento de mensagens está ativado.	true.
storageEncryption	boolean	Indica se a criptografia de armazenamento está ativada.	false.
storageSecretKey	string	A chave de criptografia de armazenamento.	xxxxx.
capacityType	string	O modo de capacidade. Valores válidos: provisioned : Provisionada + elástica. ondemand : Pay-as-you-go.	provisioned.
provisionedCapacity	integer	A capacidade provisionada.	3000
drReplicationMode	string	O modo de replicação entre regiões.	async_cross_az.
maxDelayTime	integer	O intervalo máximo para mensagens agendadas. Unidade: segundos.	3456000
adaptiveElasticity	boolean		false
aclInfo	object	As informações de controle de acesso.
aclTypes	array	A lista de tipos de autenticação da instância.
	string	O tipo de autenticação da instância. Valores válidos: default : Reconhecimento inteligente de identidade. apache_acl : Reconhecimento de identidade ACL.	default.
defaultVpcAuthFree	boolean	Especifica se o acesso sem autenticação pela rede interna está ativado. Valores válidos: true : Ativado. false : Desativado.	true.
aclType `deprecated`	string	O tipo de autenticação da instância. Este campo está obsoleto. Use o campo aclTypes. Valores válidos: default : Reconhecimento inteligente de identidade. apache_acl : Reconhecimento de identidade ACL.	default.
software	object	As informações de software da instância.
softwareVersion	string	A versão do software.	5.0-rmq-20230619-1
maintainTime `deprecated`	string	A janela de manutenção para atualizações.	02:00-06:00
upgradeMethod	string	O método de atualização. Valores válidos: auto : Atualização automática. maunal : Atualização manual.	auto.
topicCount	integer	O número de tópicos.	10
groupCount	integer	O número de grupos de consumidores.	10
tags	array<object>	A lista de tags de recurso.
	object	A tag de recurso.
key	string	A chave da tag do recurso.	chave.
value	string	O valor da tag do recurso.	valor.
autoRenew	boolean	Indica se a renovação automática está ativada.	false.
autoRenewPeriod	integer	Indica se a renovação automática está ativada.	false.
code	string	O código de erro.	MissingInstanceId.
message	string	A mensagem de erro.	Parameter instanceId is mandatory for this action .
httpStatusCode	integer	O código de status HTTP.	400
dynamicCode	string	O código de erro dinâmico.	InstanceId.
dynamicMessage	string	A mensagem de erro dinâmica.	instanceId.

Exemplos

Resposta de sucesso

JSON formato

{
  "requestId": "05AB7FBD-F1D3-5D87-BF78-BD782249****",
  "success": true,
  "data": {
    "regionId": "cn-hangzhou.",
    "instanceId": "rmq-cn-7e22ody****",
    "instanceName": "instância de teste.",
    "status": "RUNNING.",
    "startTime": "2022-08-01 00:00:00",
    "expireTime": "2022-09-01 00:00:00",
    "releaseTime": "2022-09-07 00:00:00",
    "userId": "111111111111111",
    "bid": "26842",
    "commodityCode": "ons_rmqsub_public_cn.",
    "serviceCode": "rmq.",
    "seriesCode": "standard.",
    "subSeriesCode": "cluster_ha.",
    "paymentType": "Subscription.",
    "remark": "Esta é uma observação para a instância.",
    "networkInfo": {
      "vpcInfo": {
        "vpcId": "vpc-uf6of9452b2pba82c****",
        "vSwitchId": "vsw-uf6gwtbn6etadpvz7****",
        "vSwitches": [
          {
            "vSwitchId": "vsw-uf6gwtbn6etadpvz7****",
            "zoneId": "cn-hangzhou."
          }
        ],
        "securityGroupIds": "sg-hp35r2hc3a3sv8q2sb16"
      },
      "endpoints": [
        {
          "endpointType": "TCP_INTERNET.",
          "endpointUrl": "rmq-cn-c4d2tbk****-vpc.cn-hangzhou.rmq.aliyuncs.com:8080",
          "ipWhitelist": [
            "192.168.x.x/24"
          ],
          "endpointId": "ep-bpxxx."
        }
      ],
      "internetInfo": {
        "internetSpec": "enable.",
        "flowOutType": "payByBandwidth.",
        "flowOutBandwidth": 1,
        "ipWhitelist": [
          "192.168.x.x/24"
        ]
      }
    },
    "accountInfo": {
      "username": "6W0xz2uPfiwp****"
    },
    "instanceQuotas": [
      {
        "quotaName": "TOPIC_COUNT.",
        "usedCount": 10,
        "freeCount": 20,
        "totalCount": 100
      }
    ],
    "createTime": "2022-08-01 00:00:00 ",
    "updateTime": "2022-08-02 00:00:00 ",
    "extConfig": {
      "aclType": "default.",
      "sendReceiveRatio": 0.5,
      "autoScaling": true,
      "messageRetentionTime": 72,
      "supportAutoScaling": true,
      "internetSpec": "enable.",
      "flowOutType": "payByBandwidth.",
      "flowOutBandwidth": 10,
      "msgProcessSpec": "rmq.s2.2xlarge."
    },
    "resourceGroupId": "rg-acfm3tmjruyribi.",
    "productInfo": {
      "msgProcessSpec": "rmq.s2.2xlarge.",
      "sendReceiveRatio": 0.5,
      "autoScaling": true,
      "messageRetentionTime": 72,
      "supportAutoScaling": true,
      "traceOn": true,
      "storageEncryption": true,
      "storageSecretKey": "xxxxx.",
      "capacityType": "provisioned.",
      "provisionedCapacity": 3000,
      "drReplicationMode": "async_cross_az.",
      "maxDelayTime": 3456000,
      "adaptiveElasticity": false
    },
    "aclInfo": {
      "aclTypes": [
        "default."
      ],
      "defaultVpcAuthFree": true,
      "aclType": "default."
    },
    "software": {
      "softwareVersion": "5.0-rmq-20230619-1",
      "maintainTime": "02:00-06:00",
      "upgradeMethod": "auto."
    },
    "topicCount": 10,
    "groupCount": 10,
    "tags": [
      {
        "key": "chave.",
        "value": "valor."
      }
    ],
    "autoRenew": true,
    "autoRenewPeriod": 0
  },
  "code": "MissingInstanceId.",
  "message": "Parameter instanceId is mandatory for this action .",
  "httpStatusCode": 400,
  "dynamicCode": "InstanceId.",
  "dynamicMessage": "instanceId."
}

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.