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

Este tópico apresenta um exemplo de consulta aos grupos de aplicativos da conta atual. A resposta indica que a conta possui dois grupos de aplicativos chamados testGroup124 e test123.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	DescribeMonitorGroups	A operação a ser executada. Defina o valor como DescribeMonitorGroups.
SelectContactGroups	Boolean	Não	true	Especifica se os grupos de contatos de alerta devem ser incluídos na resposta. Valores válidos: true: inclui os grupos de contatos de alerta. false: exclui os grupos de contatos de alerta.
PageNumber	Integer	Não	1	O número da página. A numeração começa em 1. Valor padrão: 1.
PageSize	Integer	Não	30	O número de entradas por página. A numeração começa em 1. Valor padrão: 30.
Keyword	String	Não	test	A palavra-chave de pesquisa.
InstanceId	String	Não	i-abcdefgh12****	O ID da instância. Use este parâmetro para consultar o grupo de aplicativos ao qual a instância especificada pertence.
GroupName	String	Não	testGroup124	O nome do grupo de aplicativos.
IncludeTemplateHistory	Boolean	Não	true	Especifica se os modelos de alerta históricos aplicados ao grupo de aplicativos devem ser incluídos na resposta. Valores válidos: true: inclui os modelos de alerta históricos. false: exclui os modelos de alerta históricos.
Type	String	Não	custom	O tipo do grupo de aplicativos. Valores válidos: custom: grupo de aplicativos autogerenciado. ehpc_cluster: grupo de aplicativos sincronizado de um cluster Elastic High Performance Computing (E-HPC). kubernetes: grupo de aplicativos sincronizado de um cluster Container Service for Kubernetes (ACK).
DynamicTagRuleId	String	Não	6b882d9a-5117-42e2-9d0c-4749a0c6****	O ID da regra de tag.
GroupFounderTagKey	String	Não	GroupKey1	A chave de tag criada para o grupo de aplicativos por meio da regra de tag.
GroupFounderTagValue	String	Não	GroupValue1	O valor de tag criado para o grupo de aplicativos por meio da regra de tag.
GroupId	String	Não	92****	Os IDs dos grupos de aplicativos. Separe vários IDs com vírgulas (,).
Tag.N.Key	String	Não	tagKey1	A chave de tag do grupo de aplicativos. Valores válidos de N: 1 a 5.
Tag.N.Value	String	Não	tagValue1	O valor de tag do grupo de aplicativos. Valores válidos de N: 1 a 5.
Types	String	Não	custom	O tipo do grupo de aplicativos. Valores válidos: custom: grupo de aplicativos autogerenciado. ehpc_cluster: grupo de aplicativos sincronizado de um cluster E-HPC. kubernetes: grupo de aplicativos sincronizado de um cluster ACK. tag: grupo de aplicativos criado automaticamente por tags. resMgr: grupo de aplicativos criado por grupos de recursos. ess: grupo de aplicativos sincronizado do Auto Scaling (ESS).

Para obter mais informações sobre parâmetros de solicitação comuns, consulte Parâmetros comuns.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	F02B299A-D374-4595-9F55-7534D604F132	O ID da solicitação.
Success	Boolean	true	Indica se a solicitação foi bem-sucedida. Valores válidos: true false
Code	Integer	200	O código de status. Nota O código de status 200 indica que a solicitação foi bem-sucedida.
Message	String	The specified resource is not found.	A mensagem de erro.
PageNumber	Integer	1	O número da página.
PageSize	Integer	30	O número de entradas por página.
Total	Integer	10	O número total de entradas retornadas.
Resources	Array of Resource		Os recursos associados ao grupo de aplicativos.
Resource
Type	String	custom	O tipo do grupo de aplicativos. Valores válidos: custom: grupo de aplicativos autogerenciado. ehpc_cluster: grupo de aplicativos sincronizado de um cluster E-HPC. kubernetes: grupo de aplicativos sincronizado de um cluster ACK.
GroupFounderTagValue	String	GroupValue1	O valor de tag criado para o grupo de aplicativos por meio da regra de tag.
BindUrl	String	https://aliyun.com	A URL do cluster ACK de onde o grupo de aplicativos é sincronizado.
GroupName	String	test123	O nome do grupo de aplicativos.
GroupId	Long	12345	O ID do grupo de aplicativos.
ServiceId	String	49****	O ID do serviço Alibaba Cloud.
DynamicTagRuleId	String	6b882d9a-5117-42e2-9d0c-4749a0c6****	O ID da regra de tag.
GmtCreate	Long	1603181891000	O timestamp de criação do grupo de aplicativos. Unidade: milissegundos.
GroupFounderTagKey	String	GroupKey1	A chave de tag criada para o grupo de aplicativos por meio da regra de tag.
GmtModified	Long	1603181891000	O timestamp da última modificação do grupo de aplicativos. Unidade: milissegundos.
ContactGroups	Array of ContactGroup		Os grupos de contatos de alerta.
ContactGroup
Name	String	CloudMonitor	O nome do grupo de contatos de alerta.
Tags	Array of Tag		As tags associadas ao grupo de aplicativos.
Tag
Key	String	tagKey1	A chave de tag do grupo de aplicativos.
Value	String	tagValue1	O valor de tag do grupo de aplicativos.
TemplateIds	Array of String	92****	Os modelos de alerta aplicados ao grupo de aplicativos.
ResourceGroupId	String	rg-aek2hopjh*******	O ID do recurso.

Exemplos

Exemplos de solicitações

http(s)://[Endpoint]/?Action=DescribeMonitorGroups
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

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

<DescribeMonitorGroupsResponse>
    <RequestId>F02B299A-D374-4595-9F55-7534D604F132</RequestId>
    <PageSize>30</PageSize>
    <PageNumber>1</PageNumber>
    <Total>2</Total>
    <Resources>
        <Resource>
            <GroupName>testGroup124</GroupName>
            <ContactGroups>
                <ContactGroup>
                    <Name>CloudMonitor</Name>
                </ContactGroup>
            </ContactGroups>
            <Type>custom</Type>
            <GmtCreate>1603181891000</GmtCreate>
            <GmtModified>1603181891000</GmtModified>
            <GroupFounderTagKey>1204</GroupFounderTagKey>
            <GroupFounderTagValue>001</GroupFounderTagValue>
            <TemplateIds>
                <TemplateId>92****</TemplateId>
            </TemplateIds>
            <Tags>
                <Tag>
                    <Value>tagKey1</Value>
                    <Key>tagValue1</Key>
                </Tag>
            </Tags>
            <GroupId>7301****</GroupId>
        </Resource>
        <Resource>
            <GroupName>test123</GroupName>
            <ContactGroups>
                <ContactGroup>
                    <Name>CloudMonitor</Name>
                </ContactGroup>
            </ContactGroups>
            <Type>tag</Type>
            <GmtCreate>1603181891000</GmtCreate>
            <DynamicTagRuleId>6b882d9a-5117-42e2-9d0c-4749a0c6****</DynamicTagRuleId>
            <GmtModified>1603181891000</GmtModified>
            <GroupFounderTagKey>GroupKey1</GroupFounderTagKey>
            <GroupFounderTagValue>GroupValue1</GroupFounderTagValue>
            <TemplateIds>
            </TemplateIds>
            <Tags>
            </Tags>
            <GroupId>92****</GroupId>
        </Resource>
    </Resources>
    <Code>200</Code>
    <Success>true</Success>
</DescribeMonitorGroupsResponse>

Formato JSON

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

{
  "RequestId" : "F02B299A-D374-4595-9F55-7534D604F132",
  "PageSize" : 30,
  "PageNumber" : 1,
  "Total" : 2,
  "Resources" : {
    "Resource" : [ {
      "GroupName" : "testGroup124",
      "ContactGroups" : {
        "ContactGroup" : [ {
          "Name" : "CloudMonitor"
        } ]
      },
      "Type" : "custom",
      "GmtCreate" : 1603181891000,
      "GmtModified" : 1603181891000,
      "GroupFounderTagKey" : "1204",
      "GroupFounderTagValue" : "001",
      "TemplateIds" : {
        "TemplateId" : [ "92****" ]
      },
      "Tags" : {
        "Tag" : [ {
          "Value" : "tagKey1",
          "Key" : "tagValue1"
        } ]
      },
      "GroupId" : "7301****"
    }, {
      "GroupName" : "test123",
      "ContactGroups" : {
        "ContactGroup" : [ {
          "Name" : "CloudMonitor"
        } ]
      },
      "Type" : "tag",
      "GmtCreate" : 1603181891000,
      "DynamicTagRuleId" : "6b882d9a-5117-42e2-9d0c-4749a0c6****",
      "GmtModified" : 1603181891000,
      "GroupFounderTagKey" : "GroupKey1",
      "GroupFounderTagValue" : "GroupValue1",
      "TemplateIds" : {
        "TemplateId" : [ ]
      },
      "Tags" : {
        "Tag" : [ ]
      },
      "GroupId" : "92****"
    } ]
  },
  "Code" : 200,
  "Success" : true
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
404	ResourceNotFound	The specified resource is not found.	O recurso especificado não foi encontrado.

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.