OnsInstanceBaseInfo - : Central de Documentação do Alibaba Cloud

Observações de uso

Para publicar e assinar mensagens, o cliente deve se conectar a uma instância do Message Queue for Apache RocketMQ por meio de um endpoint. Utilize esta operação para consultar os endpoints da instância.

Limites de solicitação

Cada conta Alibaba Cloud pode chamar esta operação até 50 vezes por segundo. Se a frequência de chamadas exceder o limite, o throttling será acionado, o que pode afetar seus negócios. Recomendamos observar esse limite ao chamar esta operação. Para mais informações, consulte Limites de solicitação.

Autorização

Por padrão, apenas contas Alibaba Cloud podem chamar esta operação. Um usuário do Resource Access Management (RAM) só poderá executá-la após receber as permissões necessárias. A tabela a seguir descreve as permissões obrigatórias para um usuário RAM chamar esta operação. Para saber como conceder permissões, consulte Políticas e exemplos.

API	Action	Resource
OnsInstanceBaseInfo	mq:QueryInstanceBaseInfo	acs:mq:::{instanceId}

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	OnsInstanceBaseInfo	A operação a ser executada. Defina o valor como OnsInstanceBaseInfo.
InstanceId	String	Sim	MQ_INST_138015630679****_BAAy1Hac	O ID da instância a ser consultada.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
InstanceBaseInfo	Object		Informações sobre a instância.
Endpoints	Object		Endpoints correspondentes a diferentes protocolos.
TcpEndpoint	String	http://MQ_INST_138015630679****_BAAy1Hac.cn-chengdu.mq-internal.aliyuncs.com:8080	Endpoint TCP privado da instância.
TcpInternetEndpoint	String	http://MQ_INST_138015630679****_BAAy1Hac.mq.cn-chengdu.aliyuncs.com:80	Endpoint TCP público da instância. Apenas instâncias nas regiões China (Chengdu), China (Qingdao) ou China (Shenzhen) oferecem suporte a endpoints TCP públicos. Antes de usar um endpoint TCP público, atualize o SDK do cliente para a versão correspondente: SDK de cliente TCP para Java: V2.0.0.Final ou posterior. Para mais informações, consulte Notas de versão do SDK para Java. SDK de cliente TCP para C++: V3.0.0 ou posterior. Para mais informações, consulte Notas de versão do SDK para C++. O uso de um endpoint TCP público incorre em custos de transferência de dados. Para mais informações, consulte Custo de transferência de dados.
HttpInternetEndpoint	String	http://138015630679****.mqrest.cn-chengdu.aliyuncs.com	Endpoint HTTP público da instância.
HttpInternalEndpoint	String	http://138015630679****.mqrest.cn-chengdu-internal.aliyuncs.com	Endpoint HTTP privado da instância.
HttpInternetSecureEndpoint	String	https://138015630679****.mqrest.cn-chengdu.aliyuncs.com	Endpoint HTTPS público da instância.
IndependentNaming	Boolean	true	Indica se há um namespace configurado para a instância. Valores válidos: true: Há um namespace separado configurado para a instância. O nome de cada recurso deve ser único dentro da instância. Nomes de recursos em instâncias diferentes podem ser iguais. false: Não há namespace separado configurado para a instância. O nome de cada recurso deve ser globalmente único entre todas as instâncias.
MaxTps	Long	10000	Número máximo de transações por segundo (TPS) para publicação e assinatura de mensagens. Valores válidos: 5000, 10000, 20000, 50000, 100000, 200000, 300000, 500000, 800000 e 1000000. Para mais informações, consulte a descrição na página de compra. Nota Este parâmetro está disponível apenas para instâncias do Message Queue for Apache RocketMQ da Enterprise Platinum Edition.
Remark	String	onspre-cn-m7r1r5f****	Descrição da instância.
InstanceName	String	test	Nome da instância. O nome deve ter de 3 a 64 caracteres e pode conter letras, dígitos, hifens (-) e sublinhados (_).
ReleaseTime	Long	1603555200000	Momento em que a instância da Enterprise Platinum Edition expira.
TopicCapacity	Integer	50	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 está disponível apenas para instâncias do Message Queue for Apache RocketMQ da Enterprise Platinum Edition.
InstanceStatus	Integer	5	Status da instância. Valores válidos: 0: A instância está sendo implantada. Este valor é válido apenas para instâncias da Enterprise Platinum Edition. 2: A instância expirou ou possui pagamentos pendentes. Este valor é válido para instâncias da Standard Edition. 5: A instância está em execução. 7: A instância está sendo atualizada e permanece em execução. Este valor é válido apenas para instâncias da Enterprise Platinum Edition.
InstanceId	String	MQ_INST_138015630679****_BAAy1Hac	ID da instância.
InstanceType	Integer	2	Edição da instância. Valores válidos: 1: Standard Edition (pagamento conforme o uso) 2: Enterprise Platinum Edition (assinatura) Para obter informações sobre as edições e especificações das instâncias do Message Queue for Apache RocketMQ, consulte Edições de instância.
RequestId	String	6CC46974-65E8-4C20-AB07-D20D102E****	ID da solicitação. O sistema gera um ID exclusivo para cada solicitação. Use este ID para solucionar problemas.

Exemplos

Exemplos de solicitações

http(s)://ons.cn-chengdu.aliyuncs.com/?Action=OnsInstanceBaseInfo
&InstanceId=MQ_INST_138015630679****_BAAy1Hac
&Common request parameters

Exemplos de respostas de sucesso

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<OnsInstanceBaseInfoResponse>
    <InstanceBaseInfo>
        <Endpoints>
            <TcpEndpoint>http://MQ_INST_138015630679****_BAAy1Hac.cn-chengdu.mq-internal.aliyuncs.com:8080</TcpEndpoint>
            <HttpInternetEndpoint>http://138015630679****.mqrest.cn-chengdu.aliyuncs.com</HttpInternetEndpoint>
            <HttpInternalEndpoint>http://138015630679****.mqrest.cn-chengdu-internal.aliyuncs.com</HttpInternalEndpoint>
            <HttpInternetSecureEndpoint>https://138015630679****.mqrest.cn-chengdu.aliyuncs.com</HttpInternetSecureEndpoint>
            <TcpInternetEndpoint>http://MQ_INST_138015630679****_BAAy1Hac.mq.cn-chengdu.aliyuncs.com:80</TcpInternetEndpoint>
        </Endpoints>
        <IndependentNaming>true</IndependentNaming>
        <MaxTps>10000</MaxTps>
        <Remark>onspre-cn-m7r1r5f****</Remark>
        <InstanceName>test</InstanceName>
        <ReleaseTime>1603555200000</ReleaseTime>
        <TopicCapacity>50</TopicCapacity>
        <InstanceStatus>5</InstanceStatus>
        <InstanceId>MQ_INST_138015630679****_BAAy1Hac</InstanceId>
        <InstanceType>2</InstanceType>
    </InstanceBaseInfo>
    <RequestId>6CC46974-65E8-4C20-AB07-D20D102E****</RequestId>
</OnsInstanceBaseInfoResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "InstanceBaseInfo" : {
    "Endpoints" : {
      "TcpEndpoint" : "http://MQ_INST_138015630679****_BAAy1Hac.cn-chengdu.mq-internal.aliyuncs.com:8080",
      "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",
      "TcpInternetEndpoint" : "http://MQ_INST_138015630679****_BAAy1Hac.mq.cn-chengdu.aliyuncs.com:80"
    },
    "IndependentNaming" : true,
    "MaxTps" : 10000,
    "Remark" : "onspre-cn-m7r1r5f****",
    "InstanceName" : "test",
    "ReleaseTime" : 1603555200000,
    "TopicCapacity" : 50,
    "InstanceStatus" : 5,
    "InstanceId" : "MQ_INST_138015630679****_BAAy1Hac",
    "InstanceType" : 2
  },
  "RequestId" : "6CC46974-65E8-4C20-AB07-D20D102E****"
}

Códigos de erro

Para obter uma lista de códigos de erro, visite a Central de Erros de API.