OnsInstanceBaseInfo - - Centro de documentación de Alibaba Cloud

Consulta información básica sobre una instancia de Message Queue for Apache RocketMQ y sus endpoints para publicar y suscribirse a mensajes.

Notas de uso

Para publicar y suscribirse a mensajes, el cliente debe conectarse a una instancia de Message Queue for Apache RocketMQ mediante un endpoint. Llame a esta operación para consultar los endpoints de la instancia.

Límites de solicitud

Puede llamar a esta operación hasta 50 veces por segundo con cada cuenta de Alibaba Cloud. Si el número de llamadas por segundo supera el límite, se activa el control de flujo y su servicio podría verse afectado. Se recomienda tener en cuenta este límite al llamar a esta operación. Para obtener más información, consulte Límites de solicitud.

Autorización

De forma predeterminada, solo las cuentas de Alibaba Cloud pueden llamar a esta operación. Un usuario de Resource Access Management (RAM) solo puede llamar a esta operación después de que se le hayan otorgado los permisos obligatorios. La tabla a continuación describe los permisos que deben otorgarse a un usuario de RAM para llamar a esta operación. Para obtener información sobre cómo otorgar permisos, consulte Directivas y ejemplos.

API	Acción	Recurso
OnsInstanceBaseInfo	mq:QueryInstanceBaseInfo	acs:mq:::{instanceId}

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	OnsInstanceBaseInfo	La operación que desea ejecutar. Establezca el valor en OnsInstanceBaseInfo.
InstanceId	String	Sí	MQ_INST_138015630679****_BAAy1Hac	El ID de la instancia que desea consultar.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
InstanceBaseInfo	Object		Información de la instancia.
Endpoints	Object		Endpoints correspondientes a diferentes protocolos.
TcpEndpoint	String	http://MQ_INST_138015630679****_BAAy1Hac.cn-chengdu.mq-internal.aliyuncs.com:8080	Endpoint TCP privado de la instancia.
TcpInternetEndpoint	String	http://MQ_INST_138015630679****_BAAy1Hac.mq.cn-chengdu.aliyuncs.com:80	Endpoint TCP público de la instancia. Solo las instancias en las regiones China (Chengdu), China (Qingdao) o China (Shenzhen) admiten endpoints TCP públicos. Antes de usar un endpoint TCP público, actualice el SDK del cliente a la versión correspondiente: SDK de cliente TCP para Java: V2.0.0.Final o posterior. Para obtener más información, consulte Notas de versión del SDK para Java. SDK de cliente TCP para C++: V3.0.0 o posterior. Para obtener más información, consulte Notas de versión del SDK para C++. Debe pagar el costo de transferencia de datos cuando utilice un endpoint TCP público. Para obtener más información, consulte Costo de transferencia de datos.
HttpInternetEndpoint	String	http://138015630679****.mqrest.cn-chengdu.aliyuncs.com	Endpoint HTTP público de la instancia.
HttpInternalEndpoint	String	http://138015630679****.mqrest.cn-chengdu-internal.aliyuncs.com	Endpoint HTTP privado de la instancia.
HttpInternetSecureEndpoint	String	https://138015630679****.mqrest.cn-chengdu.aliyuncs.com	Endpoint HTTPS público de la instancia.
IndependentNaming	Boolean	true	Indica si hay un namespace configurado para la instancia. Valores válidos: true: Hay un namespace independiente configurado para la instancia. El nombre de cada recurso debe ser único dentro de la instancia. Los nombres de los recursos en diferentes instancias pueden ser iguales. false: No hay un namespace independiente configurado para la instancia. El nombre de cada recurso debe ser globalmente único entre todas las instancias.
MaxTps	Long	10000	Número máximo de transacciones por segundo (TPS) para publicar y suscribirse a mensajes. Valores válidos: 5000, 10000, 20000, 50000, 100000, 200000, 300000, 500000, 800000 y 1000000. Para obtener más información, consulte la descripción en la página de compra. Nota Este parámetro solo está disponible para instancias de Message Queue for Apache RocketMQ Enterprise Platinum Edition.
Remark	String	onspre-cn-m7r1r5f****	Descripción de la instancia.
InstanceName	String	test	Nombre de la instancia. El nombre debe tener entre 3 y 64 caracteres y puede contener letras, dígitos, guiones (-) y guiones bajos (_).
ReleaseTime	Long	1603555200000	Momento en que expira la instancia Enterprise Platinum Edition.
TopicCapacity	Integer	50	Número máximo de topics que se pueden crear en la instancia. Valores válidos: 25, 50, 100, 300 y 500. Nota Este parámetro solo está disponible para instancias de Message Queue for Apache RocketMQ Enterprise Platinum Edition.
InstanceStatus	Integer	5	Estado de la instancia. Valores válidos: 0: La instancia se está desplegando. Este valor solo es válido para instancias Enterprise Platinum Edition. 2: La instancia ha expirado o tiene pagos pendientes. Este valor es válido para instancias Standard Edition. 5: La instancia se está ejecutando. 7: La instancia se está actualizando y se encuentra en ejecución. Este valor solo es válido para instancias Enterprise Platinum Edition.
InstanceId	String	MQ_INST_138015630679****_BAAy1Hac	ID de la instancia.
InstanceType	Integer	2	Edición de la instancia. Valores válidos: 1: Standard Edition (pay-as-you-go) 2: Enterprise Platinum Edition (suscripción) Para obtener información sobre las ediciones y especificaciones de las instancias de Message Queue for Apache RocketMQ, consulte Ediciones de instancia.
RequestId	String	6CC46974-65E8-4C20-AB07-D20D102E****	ID de la solicitud. El sistema genera un ID único para cada solicitud. Puede solucionar problemas basándose en el ID de la solicitud.

Ejemplos

Solicitudes de ejemplo

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

Respuestas exitosas de ejemplo

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 error

Para obtener una lista de códigos de error, visite el Centro de errores de API.