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

Observação

Esta operação consulta uma lista de recursos, não seus detalhes individuais.

Limite de QPS

O limite de consultas por segundo (QPS) desta operação é 10 por usuário. Se o número de chamadas por segundo exceder esse limite, o sistema acionará o throttling, o que pode afetar seu negócio. Recomendamos observar atentamente o limite de QPS desta operação. Para mais informações, consulte Limite de QPS.

Informações de autorização

Contas Alibaba Cloud e usuários RAM podem chamar esta operação sem autorização prévia. No entanto, quando um usuário RAM executa a chamada, o sistema retorna apenas os dados dos recursos com permissão de publicação e assinatura. Para obter dados de outros recursos, a conta Alibaba Cloud deve conceder as permissões necessárias ao usuário RAM. Para mais informações, consulte Políticas e exemplos.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	OnsGroupList	A operação a ser executada. Defina o valor como OnsGroupList.
InstanceId	String	Sim	MQ_INST_111111111111_DOxxxxxx	ID da instância do Message Queue for Apache RocketMQ à qual os grupos consultados pertencem.
GroupId	String	Não	GID_test_group_id	Necessário apenas para consultar informações de grupos específicos por busca aproximada. Se omitido, o sistema consulta as informações de todos os grupos. Se definido como GID_ABC, o sistema retorna as informações dos grupos cujos IDs contêm GID_ABC. Por exemplo, retornará as informações dos grupos GID_test_GID_ABC_123 e GID_ABC_356.
GroupType	String	Não	tcp	Protocolo usado pelos grupos consultados para publicar ou assinar mensagens. Todos os clientes do mesmo grupo se comunicam com os brokers pelo mesmo protocolo. Um grupo não pode conter simultaneamente clientes TCP e HTTP; crie grupos distintos para cada protocolo. Valores válidos: tcp: o grupo publica ou assina mensagens via TCP. Valor padrão. http: o grupo publica ou assina mensagens via HTTP.
Tag.N.Key	String	Sim	CartService	Chave da tag associada ao grupo. Parâmetro opcional, mas, se configurado, exige também a configuração de Tag.N.Value. A configuração conjunta de Tag.N.Key e Tag.N.Value filtra os IDs dos grupos pela tag especificada. Caso contrário, todos os IDs de grupo são consultados. Valores válidos de N: 1 a 20. O valor não pode ser uma string vazia. Máximo de 128 caracteres. Não pode começar com aliyun ou acs:, nem conter http:// ou https://.
Tag.N.Value	String	Sim	ServiceA	Valor da tag associada ao grupo. Parâmetro opcional, mas, se configurado, exige também a configuração de Tag.N.Key. A configuração conjunta de Tag.N.Key e Tag.N.Value filtra os IDs dos grupos pela tag especificada. Caso contrário, todos os IDs de grupo são consultados. Valores válidos de N: 1 a 20. O valor pode ser uma string vazia. Máximo de 128 caracteres. Não pode começar com aliyun ou acs:, nem conter http:// ou https://.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	16996623-AC4A-43AF-9248-FD9D2D75****	ID da solicitação. Parâmetro comum e exclusivo para cada solicitação, útil para solução de problemas e localização de falhas.
Data	Array of SubscribeInfoDo		Lista de assinaturas retornada.
SubscribeInfoDo
Owner	String	138015630679****	ID da conta Alibaba Cloud do usuário que criou as mensagens assinadas pelo grupo.
UpdateTime	Long	1570700979000	Horário da última atualização do ID do grupo.
IndependentNaming	Boolean	true	Indica se há um namespace configurado para a instância do Message Queue for Apache RocketMQ. Valores válidos: true: a instância possui um namespace separado. Os nomes dos recursos devem ser exclusivos dentro da instância, mas recursos em instâncias diferentes podem ter o mesmo nome. false: não há namespace separado configurado para a instância. Os nomes dos recursos devem ser exclusivos em todas as instâncias.
GroupId	String	GID_test_group_id	ID do grupo de consumidores.
Remark	String	test	Observações dos grupos retornados.
CreateTime	Long	1568896605000	Horário de criação do grupo.
Tags	Array of Tag		Tags associadas ao grupo.
Tag
Key	String	CartService	Chave da tag.
Value	String	ServiceA	Valor da tag.
InstanceId	String	MQ_INST_111111111111_DOxxxxxx	ID da instância do Message Queue for Apache RocketMQ.
GroupType	String	tcp	Protocolo usado pelos grupos consultados para publicar ou assinar mensagens. Todos os clientes do mesmo grupo se comunicam com os brokers pelo mesmo protocolo. Um grupo não pode conter simultaneamente clientes TCP e HTTP; crie grupos distintos para cada protocolo. Valores válidos: tcp: o grupo publica ou assina mensagens via TCP. http: o grupo publica ou assina mensagens via HTTP.

Exemplos

Solicitações de exemplo

http(s)://ons.cn-hangzhou.aliyuncs.com/?Action=OnsGroupList
&InstanceId=MQ_INST_111111111111_DOxxxxxx
&Tag.1.Key=CartService
&Tag.1.Value=ServiceA
&<Common request parameters>

Respostas de sucesso de exemplo

Formato XML

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

<OnsGroupListResponse>
<RequestId>16996623-AC4A-43AF-9248-FD9D2D75****</RequestId>
<Data>
    <SubscribeInfoDo>
        <Owner>138015630679****</Owner>
        <GroupType>tcp</GroupType>
        <InstanceId>MQ_INST_111111111111_DOxxxxxx</InstanceId>
        <CreateTime>1568896605000</CreateTime>
        <UpdateTime>1570700979000</UpdateTime>
        <IndependentNaming>true</IndependentNaming>
        <GroupId>GID_test_group_id</GroupId>
        <Remark>test</Remark>
        <Tags>
            <Tag>
                <Value>ServiceA</Value>
                <Key>CartService</Key>
            </Tag>
        </Tags>
    </SubscribeInfoDo>
</Data>
</OnsGroupListResponse>

Formato JSON

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

{
  "RequestId" : "16996623-AC4A-43AF-9248-FD9D2D75****",
  "Data" : {
    "SubscribeInfoDo" : [ {
      "Owner" : "138015630679****",
      "GroupType" : "tcp",
      "InstanceId" : "MQ_INST_111111111111_DOxxxxxx",
      "CreateTime" : 1568896605000,
      "UpdateTime" : 1570700979000,
      "IndependentNaming" : true,
      "GroupId" : "GID_test_group_id",
      "Remark" : "test",
      "Tags" : {
        "Tag" : [ {
          "Value" : "ServiceA",
          "Key" : "CartService"
        } ]
      }
    } ]
  }
}

Códigos de erro

Para obter uma lista de códigos de erro, visite o API Error Center.