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

Limite de requisições

Cada conta Alibaba Cloud pode chamar esta operação até 50 vezes por segundo. Se o número de requisições enviadas para chamar esta operação em um segundo atingir o limite, as novas requisições falharão. Isso pode interromper seus serviços. Para obter informações sobre o limite de requisições de cada operação, consulte Limites de taxa da API.

Autorização

Por padrão, apenas contas Alibaba Cloud podem chamar esta operação. Se uma instância utilizar um namespace, um usuário do Resource Access Management (RAM) só poderá chamar esta operação para consultar informações da instância após receber as permissões necessárias. Para saber como conceder permissões, consulte Políticas e exemplos.

Se a instância não utilizar um namespace, os usuários RAM poderão chamar esta operação para consultar informações da instância sem necessidade de autorização.
Caso a instância utilize um namespace, conceda ao usuário RAM a permissão mq:QueryInstanceBaseInfo sobre a instância antes de chamar esta operação. Caso contrário, a operação não retornará as informações da instância. A tabela a seguir descreve as permissões necessárias para um usuário RAM consultar uma instância com namespace.

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

Parâmetros da requisição

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	OnsInstanceInServiceList	A operação a ser executada. Defina o valor como OnsInstanceInServiceList.
Tag.N.Key	String	Sim	CartService	Chave de uma tag anexada às instâncias que você deseja consultar. Este parâmetro é opcional. Se configurado, também configure o parâmetro Tag.N.Value. Ao incluir os parâmetros Tag.N.Key e Tag.N.Value na requisição, a operação consulta apenas as instâncias com as tags especificadas. Sem esses parâmetros, a operação consulta todas as instâncias acessíveis. O valor de N deve ser um número inteiro de 1 a 20. Se incluído na requisição, o valor deste parâmetro não pode ser uma string vazia. O valor deste parâmetro deve ter no máximo 128 caracteres, não pode começar com acs: ou aliyun, nem conter http:// ou https://.
Tag.N.Value	String	Sim	SericeA	Valor de uma tag anexada às instâncias que você deseja consultar. Este parâmetro é opcional. Se configurado, também configure o parâmetro Tag.N.Key. Ao incluir os parâmetros Tag.N.Key e Tag.N.Value na requisição, a operação consulta apenas as instâncias com as tags especificadas. Sem esses parâmetros, a operação consulta todas as instâncias acessíveis. O valor de N deve ser um número inteiro de 1 a 20. O valor deste parâmetro pode ser uma string vazia. O valor deste parâmetro deve ter no máximo 128 caracteres, não pode começar com acs: ou aliyun, nem conter http:// ou https://.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	0598E46F-DB06-40E2-AD7B-C45923EE****	ID da requisição. O sistema gera um ID exclusivo para cada requisição. Use esse ID para solucionar problemas.
Data	Array of InstanceVO		Informações sobre as instâncias consultadas.
InstanceVO
IndependentNaming	Boolean	true	Indica se a instância utiliza um namespace. Valores válidos: true: A instância utiliza um namespace. O identificador de cada recurso deve ser exclusivo dentro da instância. No entanto, pode ser igual ao identificador de um recurso em outra instância com namespace diferente. false: A instância não utiliza um namespace. O identificador de cada recurso deve ser exclusivo entre todas as instâncias.
InstanceName	String	test1	Nome da instância. Deve ter de 3 a 64 caracteres e pode conter letras, dígitos, hifens (-) e sublinhados (_).
ReleaseTime	Long	1551024000000	Momento em que a instância expira. Retornado apenas para instâncias Enterprise Platinum Edition.
InstanceStatus	Integer	5	Status da instância. Valores válidos: 0: A instância está sendo implantada. Disponível apenas para instâncias Enterprise Platinum Edition. 2: A instância possui pagamentos pendentes. Disponível para instâncias Standard Edition. 5: A instância está em execução. 7: A instância está sendo atualizada e permanece em execução. Disponível apenas para instâncias Enterprise Platinum Edition.
Tags	Array of Tag		Tags anexadas à instância.
Tag
Key	String	CartService	Chave da tag.
Value	String	ServiceA	Valor da tag.
InstanceId	String	MQ_INST_188077086902****_BXSuW61e	ID da instância.
InstanceType	Integer	2	Edição da instância. Valores válidos: 1: Standard Edition 2: Enterprise Platinum Edition Para obter mais informações sobre as edições de instância e suas diferenças, consulte Edições de instância.

Exemplos

Exemplos de requisições

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

Exemplos de respostas de sucesso

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 erro

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