OnsInstanceInServiceList - - Centro de documentación de Alibaba Cloud

Consulta todas las instancias de Message Queue for Apache RocketMQ en una región dentro de la cuenta actual.

Límite de solicitudes

Cada cuenta de Alibaba Cloud puede invocar esta operación hasta 50 veces por segundo. Si el número de solicitudes enviadas para invocar esta operación en un segundo alcanza el límite de solicitudes, las nuevas solicitudes fallarán. Esto podría interrumpir su negocio. Para obtener información sobre el límite de solicitudes de cada operación, consulte Límites de velocidad de API.

Autorización

De forma predeterminada, solo las cuentas de Alibaba Cloud pueden invocar esta operación. Si una instancia utiliza un namespace, un usuario de Resource Access Management (RAM) podrá invocar esta operación para consultar la información de la instancia únicamente después de que se le hayan otorgado los permisos obligatorios. Para obtener información sobre cómo otorgar permisos, consulte Directivas y ejemplos.

Si una instancia no utiliza un namespace, los usuarios de RAM pueden invocar esta operación para consultar la información de la instancia sin necesidad de autorización.
Si una instancia utiliza un namespace, se debe otorgar al usuario de RAM el permiso mq:QueryInstanceBaseInfo sobre la instancia antes de que invoque esta operación. De lo contrario, la operación no devolverá la información de la instancia. La siguiente tabla describe los permisos que se deben otorgar a un usuario de RAM para consultar una instancia que utiliza un namespace.

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

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	OnsInstanceInServiceList	La operación que desea realizar. Establezca el valor en OnsInstanceInServiceList.
Tag.N.Key	String	Sí	CartService	La clave de una etiqueta asociada a las instancias que desea consultar. Este parámetro no es obligatorio. Si configura este parámetro, también debe configurar el parámetro Tag.N.Value. Si incluye los parámetros Tag.N.Key y Tag.N.Value en una solicitud, esta operación consulta únicamente las instancias que utilizan las etiquetas especificadas. Si no incluye estos parámetros en una solicitud, la operación consulta todas las instancias a las que tiene acceso. El valor de N debe ser un número entero del 1 al 20. Si incluye este parámetro en una solicitud, su valor no puede ser una cadena vacía. El valor de este parámetro debe tener una longitud máxima de 128 caracteres y no puede comenzar con acs: o aliyun, ni contener http:// o https://.
Tag.N.Value	String	Sí	SericeA	El valor de una etiqueta asociada a las instancias que desea consultar. Este parámetro no es obligatorio. Si configura este parámetro, también debe configurar el parámetro Tag.N.Key. Si incluye los parámetros Tag.N.Key y Tag.N.Value en una solicitud, esta operación consulta únicamente las instancias que utilizan las etiquetas especificadas. Si no incluye estos parámetros en una solicitud, la operación consulta todas las instancias a las que tiene acceso. El valor de N debe ser un número entero del 1 al 20. El valor de este parámetro puede ser una cadena vacía. El valor de este parámetro debe tener una longitud máxima de 128 caracteres y no puede comenzar con acs: o aliyun, ni contener http:// o https://.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
RequestId	String	0598E46F-DB06-40E2-AD7B-C45923EE****	El ID de la solicitud. El sistema genera un ID único para cada solicitud. Puede utilizar el ID de solicitud para solucionar problemas.
Data	Array of InstanceVO		La información sobre las instancias consultadas.
InstanceVO
IndependentNaming	Boolean	true	Indica si la instancia utiliza un namespace. Valores válidos: true: La instancia utiliza un namespace. El identificador de cada recurso en la instancia debe ser único dentro de la misma. Sin embargo, el identificador de un recurso en la instancia puede coincidir con el identificador de un recurso en otra instancia que utilice un namespace diferente. false: La instancia no utiliza un namespace. El identificador de cada recurso en la instancia debe ser único en todas las instancias.
InstanceName	String	test1	El nombre de la instancia. El nombre de la instancia debe tener entre 3 y 64 caracteres de longitud y puede contener letras, dígitos, guiones (-) y guiones bajos (_).
ReleaseTime	Long	1551024000000	El momento en que caduca la instancia. Este parámetro se devuelve si la instancia es una instancia Enterprise Platinum Edition.
InstanceStatus	Integer	5	El estado de la instancia. Valores válidos: 0: La instancia se está desplegando. Este valor solo está disponible para instancias Enterprise Platinum Edition. 2: La instancia tiene pagos pendientes. Este valor está disponible 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 está disponible para instancias Enterprise Platinum Edition.
Tags	Array of Tag		Las etiquetas asociadas a la instancia.
Tag
Key	String	CartService	La clave de la etiqueta.
Value	String	ServiceA	El valor de la etiqueta.
InstanceId	String	MQ_INST_188077086902****_BXSuW61e	El ID de la instancia.
InstanceType	Integer	2	La edición de la instancia. Valores válidos: 1: Standard Edition 2: Enterprise Platinum Edition Para obtener más información sobre las ediciones de instancia y las diferencias entre ellas, consulte Ediciones de instancia.

Ejemplos

Solicitudes de ejemplo

http(s)://ons.cn-zhangjiakou.aliyuncs.com/?Action=OnsInstanceInServiceList
&Tag.1.Key=CartService
&Tag.1.Value=SericeA
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

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

<OnsInstanceInServiceListResponse>
<RequestId>0598E46F-DB06-40E2-AD7B-C45923EE****</RequestId>
<Data>
    <InstanceVO>
        <InstanceName>test1</InstanceName>
        <InstanceId>MQ_INST_188077086902****_BXSuW61e</InstanceId>
        <ReleaseTime>1551024000000</ReleaseTime>
        <InstanceStatus>5</InstanceStatus>
        <IndependentNaming>true</IndependentNaming>
        <InstanceType>2</InstanceType>
        <Tags>
            <Tag>
                <Value>ServiceA</Value>
                <Key>CartService</Key>
            </Tag>
        </Tags>
    </InstanceVO>
</Data>
</OnsInstanceInServiceListResponse>

Formato JSON

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

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

Códigos de error

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