DescribeDeploymentSets - Elastic Compute Service - Centre de documentation Alibaba Cloud

Décrit un ou plusieurs ensembles de déploiement.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

ecs:DescribeDeploymentSets

get

*DeploymentSet

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

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RegionId	string	Oui	L'identifiant de la région où se trouve l'ensemble de déploiement. Vous pouvez appeler DescribeRegions pour consulter la liste la plus récente des régions d'Alibaba Cloud.	cn-hangzhou
PageNumber	integer	Non	Le numéro de page. Commence à 1. Valeur par défaut : 1.	1
PageSize	integer	Non	Le nombre d'entrées par page. Valeur maximale : 50. Valeur par défaut : 10.	10
DeploymentSetIds	string	Non	Les identifiants des ensembles de déploiement. La valeur peut être un tableau JSON composé d'un maximum de 100 identifiants d'ensembles de déploiement. Exemple de format : `["ds-xxxxxxxxx", "ds-yyyyyyyyy", … "ds-zzzzzzzzz"]`.	["ds-bp67acfmxazb4ph**", "ds-bp67acfmxazb4pi", … "ds-bp67acfmxazb4pj**"]
NetworkType	string	Non	Remarque Ce paramètre est obsolète.	null
Strategy	string	Non	La stratégie de déploiement. Valeurs valides : Availability : stratégie de haute disponibilité. AvailabilityGroup : stratégie de groupe de haute disponibilité. LowLatency : stratégie à faible latence.	Availability
DeploymentSetName	string	Non	Le nom de l'ensemble de déploiement. Le nom doit comporter entre 2 et 128 caractères et peut contenir des lettres, des chiffres, des deux-points (:), des traits de soulignement (_), des points (.) et des traits d'union (-).	testDeploymentSetName
Granularity	string	Non	Remarque Ce paramètre est obsolète.	null
Domain	string	Non	Remarque Ce paramètre est obsolète.	null
Type	string	Non	Le type de déploiement. Valeurs valides : host : garantit que les instances de l'ensemble de déploiement sont déployées sur différents hôtes. sw : garantit que les instances de l'ensemble de déploiement sont déployées sur différents commutateurs. rack : garantit que les instances de l'ensemble de déploiement sont déployées sur différentes baies. Valeur par défaut : host.	host

Éléments de réponse

Élément	Type	Description	Exemple
	object
PageSize	integer	Le nombre d'entrées renvoyées par page.	1
PageNumber	integer	Le numéro de page de la liste des ensembles de déploiement.	1
RequestId	string	L'identifiant de la requête.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	Le nombre total d'ensembles de déploiement.	5
RegionId	string	L'identifiant de la région.	cn-hangzhou
DeploymentSets	object	Détails des ensembles de déploiement.
DeploymentSet	array<object>	Un tableau d'ensembles de déploiement.
	array<object>
CreationTime	string	The time when the deployment set was created.	2021-12-07T06:01:46Z
Strategy	string	The deployment strategy.	Availability
DeploymentSetId	string	The ID of the deployment set.	ds-bp67acfmxazb4ph****
AccountId	integer	The Alibaba Cloud account ID.	1732*******734
DeploymentStrategy	string	The deployment strategy. This response parameter corresponds to the value of the `Strategy` request parameter.	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. Remarque This response parameter takes effect only when the deployment set strategy is set to high availability for deployment set groups (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
InstanceId	array	The instance IDs of instances in the deployment set.
	string	The instance ID.	i-bp67acfmxazb4ph****
Capacities	object
Capacity	array<object>	The capacity information of the deployment set at the zone level. The value is an array that consists of Capacity objects. This parameter is returned only when the deployment set contains existing ECS instances.
	object
ZoneId	string	The zone ID. Only the zone IDs of existing ECS instances in the deployment set are returned.	cn-hangzhou-i
UsedAmount	integer	The number of ECS instances in the deployment set that belong to the zone.	2
AvailableAmount	integer	The number of ECS instances that can be added to the deployment set in the zone.	18
Type	string	The deployment type.	host
Affinity	integer	The affinity level of the deployment set.	3

Exemples

JSON format

{
  "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
      }
    ]
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
403	InvalidDeploymentSetIds.TooManyInput	The parameter DeploymentSets size should less than 100.	The number of specified deployment sets exceeds 100.

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.