DescribeDeploymentSets - Elastic Compute Service: Central de Documentação do Alibaba Cloud

Descreve um ou mais conjuntos de implantação.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

ecs:DescribeDeploymentSets

get

*DeploymentSet

acs:ecs:{#regionId}:{#accountId}:deploymentset/*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região onde o conjunto de implantação está localizado. Você pode chamar DescribeRegions para visualizar a lista mais recente de regiões da Alibaba Cloud.	cn-hangzhou
PageNumber	integer	Não	O número da página. Começa em 1. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página. Valor máximo: 50. Valor padrão: 10.	10
DeploymentSetIds	string	Não	Os IDs dos conjuntos de implantação. O valor pode ser uma matriz JSON que consiste em até 100 IDs de conjuntos de implantação. Formato de exemplo: `["ds-xxxxxxxxx", "ds-yyyyyyyyy", … "ds-zzzzzzzzz"]`.	["ds-bp67acfmxazb4ph**", "ds-bp67acfmxazb4pi", … "ds-bp67acfmxazb4pj**"]
NetworkType	string	Não	Nota Este parâmetro foi descontinuado.	null
Strategy	string	Não	A estratégia de implantação. Valores válidos: Availability: estratégia de alta disponibilidade. AvailabilityGroup: estratégia de grupo de alta disponibilidade. LowLatency: estratégia de baixa latência.	Availability
DeploymentSetName	string	Não	O nome do conjunto de implantação. O nome deve ter de 2 a 128 caracteres e pode conter letras, dígitos, dois-pontos (:), sublinhados (_), pontos (.) e hifens (-).	testDeploymentSetName
Granularity	string	Não	Nota Este parâmetro foi descontinuado.	null
Domain	string	Não	Nota Este parâmetro foi descontinuado.	null
Type	string	Não	O tipo de implantação. Valores válidos: host: Garante que as instâncias no conjunto de implantação sejam implantadas em hosts diferentes. sw: Garante que as instâncias no conjunto de implantação sejam implantadas em switches diferentes. rack: Garante que as instâncias no conjunto de implantação sejam implantadas em racks diferentes. Valor padrão: host.	host

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
PageSize	integer	O número de entradas retornadas por página.	1
PageNumber	integer	O número da página da lista de conjuntos de implantação.	1
RequestId	string	O ID da solicitação.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	O número total de conjuntos de implantação.	5
RegionId	string	O ID da região.	cn-hangzhou
DeploymentSets	object	Detalhes dos conjuntos de implantação.
DeploymentSet	array<object>	Uma matriz de conjuntos de implantação.
	array<object>
CreationTime	string	The creation time of the deployment set.	2021-12-07T06:01:46Z
Strategy	string	The deployment strategy.	Availability
DeploymentSetId	string	The ID of the deployment set.	ds-bp67acfmxazb4ph****
AccountId	integer	The ID of the Alibaba Cloud account.	1732*******734
DeploymentStrategy	string	The deployment strategy. This value matches the value of the request parameter `Strategy`.	Availability
DeploymentSetDescription	string	The description of the deployment set.	testDeploymentSetDescription
Domain	string	The deployment domain.	default
GroupCount	integer	The number of groups in the deployment set. Nota This parameter is returned only when the deployment strategy is the Availability Group strategy (`AvailabilityGroup`).	3
Granularity	string	The deployment granularity.	host
DeploymentSetName	string	The name of the deployment set.	testDeploymentSetName
InstanceAmount	integer	The number of instances in the deployment set.	3
InstanceIds	object	The IDs of the instances in the deployment set.
InstanceId	array	A list of instance IDs in the deployment set.
	string	The instance ID.	i-bp67acfmxazb4ph****
Capacities	object	The zone-specific capacities of the deployment set.
Capacity	array<object>	The capacity information for each zone that contains instances of the deployment set. This parameter is returned only when the deployment set contains instances.
	object
ZoneId	string	The ID of a zone that contains instances from the deployment set.	cn-hangzhou-i
UsedAmount	integer	The number of instances from the deployment set in this zone.	2
AvailableAmount	integer	The number of instances that can be added to the deployment set in the zone.	18
Type	string	The deployment granularity.	host
Affinity	integer	The affinity level of the deployment set.	3

Exemplos

Resposta de sucesso

JSON formato

{
  "PageSize": 1,
  "PageNumber": 1,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": 5,
  "RegionId": "cn-hangzhou",
  "DeploymentSets": {
    "DeploymentSet": [
      {
        "CreationTime": "2021-12-07T06:01:46Z",
        "Strategy": "Availability",
        "DeploymentSetId": "ds-bp67acfmxazb4ph****",
        "AccountId": 0,
        "DeploymentStrategy": "Availability",
        "DeploymentSetDescription": "testDeploymentSetDescription",
        "Domain": "default",
        "GroupCount": 3,
        "Granularity": "host",
        "DeploymentSetName": "testDeploymentSetName",
        "InstanceAmount": 3,
        "InstanceIds": {
          "InstanceId": [
            "i-bp67acfmxazb4ph****"
          ]
        },
        "Capacities": {
          "Capacity": [
            {
              "ZoneId": "cn-hangzhou-i",
              "UsedAmount": 2,
              "AvailableAmount": 18
            }
          ]
        },
        "Type": "host",
        "Affinity": 3
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
403	InvalidDeploymentSetIds.TooManyInput	The parameter DeploymentSets size should less than 100.	The number of specified deployment sets exceeds 100.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.