OnsInstanceBaseInfo - ApsaraMQ for RocketMQ - Centro de documentación de Alibaba Cloud

Consulta la información básica de una instancia y sus endpoints para enviar y recibir mensajes.

Descripción de la operación

Importante

La OpenAPI proporcionada por Alibaba Cloud es una API de gestión que se utiliza para administrar y consultar recursos de servicios de Alibaba Cloud. Integre la OpenAPI únicamente con fines de gestión. No utilice la OpenAPI para enlaces de datos principales que envían y reciben mensajes. Esto puede generar amenazas de seguridad para sus enlaces de datos.

Los clientes se conectan a ApsaraMQ for RocketMQ a través de endpoints para enviar y recibir mensajes. Puede llamar a esta operación para consultar los endpoints de una instancia.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

mq:QueryInstanceBaseInfo

get

*Instance

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

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
InstanceId	string	Sí	El ID de la instancia que se va a consultar.	MQ_INST_138015630679****_BAAy1Hac

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
InstanceBaseInfo	object	El objeto de información de la instancia.
Endpoints	object	Los endpoints para diferentes protocolos.
TcpEndpoint	string	El endpoint interno para el protocolo TCP.	http://MQ_INST_138015630679****_BAAy1Hac.cn-chengdu.mq-internal.aliyuncs.com:8080
TcpInternetEndpoint	string	El endpoint público para el protocolo TCP. Solo las instancias en las regiones China (Chengdu), China (Qingdao) y China (Shenzhen) admiten endpoints públicos para el protocolo TCP. Para utilizar el endpoint público para el protocolo TCP, actualice el kit de desarrollo de software (SDK) del cliente a una de las siguientes versiones: SDK de Java para TCP: 2.0.0.Final o posterior. Para obtener más información, consulte la Guía de versiones del SDK de Java. SDK de C++ para TCP: 3.0.0 o posterior. Para obtener más información, consulte la Guía de versiones del SDK de C++. Se generan costos de transferencia de datos cuando se utiliza el endpoint público para el protocolo TCP. Para obtener más información, consulte Costo de transferencia de datos.	http://MQ_INST_138015630679****_BAAy1Hac.mq.cn-chengdu.aliyuncs.com:80
HttpInternetEndpoint	string	El endpoint público para el protocolo HTTP.	http://138015630679****.mqrest.cn-chengdu.aliyuncs.com
HttpInternalEndpoint	string	El endpoint interno para el protocolo HTTP.	http://138015630679****.mqrest.cn-chengdu-internal.aliyuncs.com
HttpInternetSecureEndpoint	string	El endpoint público para el protocolo HTTPS.	https://138015630679****.mqrest.cn-chengdu.aliyuncs.com
IndependentNaming	boolean	Indica si la instancia tiene un espacio de nombres. Valores válidos: true: La instancia tiene un espacio de nombres independiente. Los nombres de los recursos deben ser únicos dentro de la instancia. Los nombres de los recursos pueden ser iguales entre distintas instancias. false: La instancia no tiene un espacio de nombres independiente. Los nombres de los recursos deben ser únicos a nivel global.	true
MaxTps	integer	El número máximo de transacciones por segundo (TPS) para enviar y recibir mensajes. Valores válidos: 5000, 10000, 20000, 50000, 100000, 200000, 300000, 500000, 800000 y 1000000. Para obtener más información, consulte la página de compra de instancias. Nota Este parámetro solo es aplicable a instancias ApsaraMQ for RocketMQ Platinum Edition.	10000
Remark	string	Las observaciones sobre la instancia.	ons-cn-m7r1r5f****
InstanceName	string	El nombre de la instancia. El nombre debe tener entre 3 y 64 caracteres de longitud y puede contener letras, dígitos, guiones (-) y guiones bajos (_).	test
ReleaseTime	integer	La hora en la que caduca la instancia Platinum Edition.	1603555200000
TopicCapacity	integer	El número máximo de temas que se pueden crear en la instancia. Valores válidos: 25, 50, 100, 300 y 500. Nota Este parámetro solo es aplicable a instancias ApsaraMQ for RocketMQ Platinum Edition.	50
InstanceStatus	integer	El estado de la instancia. Valores válidos: 0: La instancia Platinum Edition se está desplegando. 2: El pago de la instancia Standard Edition está vencido. 5: La instancia Standard Edition o Platinum Edition está en servicio. 7: La instancia Platinum Edition se está actualizando y está disponible.	5
InstanceId	string	El ID de la instancia.	MQ_INST_138015630679****_BAAy1Hac
InstanceType	integer	El tipo de la instancia. Valores válidos: 1: Instancia Standard Edition (pago por uso) 2: Instancia Platinum Edition (suscripción) Para obtener más información sobre los tipos y especificaciones de las instancias de ApsaraMQ for RocketMQ, consulte Tipos de instancias.	2
CreateTime	string	La hora en la que se creó la instancia. El valor de este parámetro es una marca de tiempo UNIX en milisegundos.	1570701259403
spInstanceId	string	El ID de commodity de la instancia.	ons-cn-m7r1r5f****
spInstanceType	integer	El tipo de venta de la instancia. Valores válidos: 1 : Instancia Standard Edition (pago por uso) 2 : Instancia Platinum Edition (suscripción)	1
SupportClassic	integer		2
RequestId	string	El parámetro común. Cada solicitud tiene un ID único que puede utilizar para solucionar problemas.	6CC46974-65E8-4C20-AB07-D20D102E****

Ejemplos

Respuesta exitosa

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 error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.