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

Consulta todas las instancias de ApsaraMQ for RocketMQ 4.x en una región especificada.

Descripción de la operación

Importante

La OpenAPI proporcionada por Alibaba Cloud es una interfaz de programación de aplicaciones (API) de gestión. Utilice esta API para gestionar y consultar recursos de los servicios de Alibaba Cloud. Integre la API únicamente con fines de gestión. No dependa de la API para enlaces de datos principales que envían y reciben mensajes. Esto puede introducir amenazas en sus enlaces de datos.

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

list

Instance

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

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
Tag	array<object>	No	Una lista de etiquetas asociadas a la instancia. La lista puede contener hasta 20 elementos.
	object	No	Una etiqueta asociada a la instancia.
Key	string	No	La clave de la etiqueta. Especifique tanto Key como Value para filtrar instancias por etiqueta. Omita ambos parámetros para consultar todas las instancias. Este parámetro no puede ser una cadena vacía. La clave de la etiqueta puede tener hasta 128 caracteres de longitud. No puede comenzar con `aliyun` ni con `acs:`. No puede contener `http://` ni `https://`.	CartService
Value	string	No	El valor de la etiqueta. Especifique tanto Key como Value para filtrar instancias por etiqueta. Omita ambos parámetros para consultar todas las instancias. Este parámetro puede ser una cadena vacía. El valor de la etiqueta puede tener hasta 128 caracteres de longitud. No puede comenzar con `aliyun` ni con `acs:`. No puede contener `http://` ni `https://`.	SericeA
NeedResourceInfo	boolean	No	Especifica si se deben devolver estadísticas de recursos. Las estadísticas incluyen el número de temas y grupos en la instancia.	true

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud. Este es un parámetro común. Cada solicitud tiene un ID único. Utilice este ID para solucionar problemas y localizar incidencias.	0598E46F-DB06-40E2-AD7B-C45923EE****
Data	object
InstanceVO	array<object>	Una lista de todas las instancias publicadas.
	array<object>	Una lista de todas las instancias publicadas.
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, pero pueden coincidir con los nombres de recursos en otras instancias. false: La instancia no tiene un espacio de nombres independiente. Los nombres de los recursos deben ser globalmente únicos dentro de la instancia y en todas las instancias.	true
InstanceName	string	El nombre de la instancia.	test1
ReleaseTime	integer	La hora de vencimiento de la instancia Platinum.	1551024000000
InstanceStatus	integer	El estado de la instancia. Valores válidos: 0: La instancia Platinum se está desplegando. 2: El pago de la instancia estándar está vencido. 5: La instancia estándar o Platinum está en servicio. 7: La instancia Platinum se está actualizando y está disponible.	5
Tags	object
Tag	array<object>	Las etiquetas asociadas a la instancia.
	object	Las etiquetas asociadas a la instancia.
Key	string	La clave de la etiqueta.	CartService
Value	string	El valor de la etiqueta.	ServiceA
InstanceId	string	El ID de la instancia.	MQ_INST_188077086902****_BXSuW61e
InstanceType	integer	El tipo de la instancia. Valores válidos: 1: Instancia estándar 2: Instancia Platinum Para obtener información sobre las especificaciones y diferencias entre los tipos de instancias, consulte Tipos de instancias.	2
CreateTime	integer	La hora en que se creó la instancia. Este valor es una marca de tiempo UNIX en milisegundos.	1640847284000
TopicCount	integer	El número de temas.	1
GroupCount	integer	El número de grupos de consumidores.	3

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "0598E46F-DB06-40E2-AD7B-C45923EE****",
  "Data": {
    "InstanceVO": [
      {
        "IndependentNaming": true,
        "InstanceName": "test1",
        "ReleaseTime": 1551024000000,
        "InstanceStatus": 5,
        "Tags": {
          "Tag": [
            {
              "Key": "CartService",
              "Value": "ServiceA"
            }
          ]
        },
        "InstanceId": "MQ_INST_188077086902****_BXSuW61e",
        "InstanceType": 2,
        "CreateTime": 1640847284000,
        "TopicCount": 1,
        "GroupCount": 3
      }
    ]
  }
}

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.