Interroge les périphériques de stockage par blocs que vous avez créés, y compris les disques cloud et les disques locaux.
Notes d'utilisation
Vous pouvez configurer plusieurs paramètres de requête tels que RegionId, ZoneId, DiskIds et InstanceId en tant que filtres. Les paramètres configurés sont évalués à l'aide de l'opérateur « ET ». Si vous spécifiez plusieurs filtres, seuls les enregistrements correspondant à tous les filtres sont renvoyés.
La valeur du paramètre DiskIds est un tableau JSON. Si le paramètre DiskIds n'est pas configuré, il n'est pas utilisé comme filtre. Si le paramètre DiskIds est défini sur un tableau JSON vide, il est considéré comme un filtre valide et un résultat vide est renvoyé.
-
Utilisez l'une des méthodes suivantes pour vérifier les réponses :
Méthode 1 : Utilisez NextToken pour configurer le jeton de requête. Définissez la valeur sur la valeur NextToken renvoyée lors du dernier appel à l'opération DescribeDisks. Ensuite, utilisez MaxResults pour spécifier le nombre maximal d'entrées à renvoyer par page.
-
Méthode 2 : Configurez le paramètre PageSize pour spécifier le nombre d'entrées à renvoyer par page, et configurez le paramètre PageNumber pour spécifier le numéro de page à renvoyer.
Vous ne pouvez utiliser qu'une seule des méthodes précédentes. Si un grand nombre d'entrées doivent être renvoyées, nous vous recommandons d'utiliser la méthode 1. Si le paramètre NextToken est configuré, les paramètres PageSize et PageNumber ne prennent pas effet et le paramètre TotalCount dans la réponse n'est pas valide.
Un disque cloud doté de la fonctionnalité multi-attach peut être attaché à plusieurs instances. Vous pouvez interroger les informations d'attachement du disque cloud en vous basant sur les valeurs Attachment de la réponse.
Lorsque vous appelez une opération API via Alibaba Cloud CLI, vous devez spécifier les valeurs des paramètres de requête de différents types de données dans les formats requis. Pour plus d'informations, consultez Présentation du format des paramètres.
Débogage
Paramètres de la requête
Paramètre | Type | Obligatoire | Exemple | Description |
Action | String | Oui | DescribeDisks | L'opération à effectuer. Définissez la valeur sur DescribeDisks. |
RegionId | String | Oui | cn-hangzhou | L'ID de région du dispositif de stockage par blocs. Vous pouvez appeler l'opération DescribeRegions pour obtenir la liste des régions les plus récentes. |
ZoneId | String | Non | cn-hangzhou-g | L'ID de zone. |
DiskIds | String | Non | ["d-bp67acfmxazb4p**", "d-bp67acfmxazb4g", … "d-bp67acfmxazb4d**"] | Les ID de disque. La valeur est un tableau JSON contenant jusqu'à 100 ID de disque. Séparez les ID de disque par des virgules (,). |
InstanceId | String | Non | i-bp67acfmxazb4q**** | L'ID de l'instance à laquelle le disque est attaché. |
DiskType | String | Non | all | Le type de disque. Valeurs possibles :
Valeur par défaut : all. |
Category | String | Non | all | La catégorie du disque. Valeurs possibles :
Valeur par défaut : all. |
Status | String | Non | All | L'état du disque cloud. Pour plus d'informations, consultez la section États des disques. Valeurs possibles :
Valeur par défaut : All. |
SnapshotId | String | Non | s-bp67acfmxazb4p**** | L'ID du snapshot utilisé pour créer le disque cloud. |
Portable | Boolean | Non | false | Indique si le disque est amovible. Valeurs possibles :
L'attribut
|
DeleteWithInstance | Boolean | Non | false | Indique s'il faut libérer le disque cloud lorsque son instance associée est libérée. Valeurs possibles :
Valeur par défaut : false. |
DeleteAutoSnapshot | Boolean | Non | false | Indique s'il faut supprimer les snapshots automatiques du disque cloud lorsque celui-ci est libéré.
Valeur par défaut : false. |
PageNumber | Integer | Non | 1 | Le numéro de page. La pagination commence à la page 1. Valeur par défaut : 1. |
PageSize | Integer | Non | 10 | Le nombre d'entrées par page. Valeur maximale : 100. Valeur par défaut : 10. |
NextToken | String | Non | AAAAAdDWBF2**** | Le jeton de pagination utilisé dans la requête suivante pour récupérer une nouvelle page de résultats. Vous devez spécifier le jeton obtenu lors de la requête précédente comme valeur de Pour savoir comment vérifier les réponses renvoyées par cette opération, consultez la section « Remarques d'utilisation » de cette rubrique. |
MaxResults | Integer | Non | 50 | Le nombre d'entrées par page. Valeurs possibles : 10 à 500. Tenez compte des éléments suivants :
|
DiskName | String | Non | testDiskName | Le nom du disque. |
AutoSnapshotPolicyId | String | Non | sp-m5e2w2jutw8bv31**** | L'ID de la politique de snapshot automatique appliquée au disque cloud. |
EnableAutoSnapshot | Boolean | Non | true | Indique s'il faut activer la fonctionnalité de politique de snapshot automatique pour le disque cloud. Valeurs possibles :
Remarque Par défaut, la fonctionnalité de politique de snapshot automatique est activée pour les disques cloud créés. Il vous suffit d'appliquer une politique de snapshot automatique à un disque cloud avant de pouvoir utiliser celle-ci. |
EnableAutomatedSnapshotPolicy | Boolean | Non | false | Indique si une politique de snapshot automatique est appliquée au disque cloud. Valeurs possibles :
Valeur par défaut : false. |
DiskChargeType | String | Non | PostPaid | La méthode de facturation du disque. Valeurs possibles :
|
LockReason | String | Non | recycling | La raison pour laquelle le disque est verrouillé. Valeurs possibles :
|
Filter.1.Key | String | Non | CreationStartTime | La clé du filtre 1 utilisée pour interroger les ressources. Définissez la valeur sur |
Filter.2.Key | String | Non | CreationEndTime | La clé du filtre 2 utilisée pour interroger les ressources. Définissez la valeur sur |
Filter.1.Value | String | Non | 2017-12-05T22:40Z | La valeur du filtre 1 utilisée pour interroger les ressources. Si vous configurez ce paramètre, vous devez également configurer le paramètre |
Filter.2.Value | String | Non | 2017-12-06T22:40Z | La valeur du filtre 2 utilisée pour interroger les ressources. Si vous configurez ce paramètre, vous devez également configurer le paramètre |
ResourceGroupId | String | Non | rg-bp67acfmxazb4p**** | ID du groupe de ressources auquel le disque appartient. Si vous utilisez ce paramètre pour filtrer les ressources, le nombre de ressources dans un groupe de ressources spécifié ne doit pas dépasser 1 000. Remarque Le filtrage des ressources appartenant au groupe de ressources par défaut n'est pas pris en charge. |
EnableShared | Boolean | Non | false | Indique si le disque est un dispositif Shared Block Storage. |
Encrypted | Boolean | Non | false | Indique s'il faut interroger uniquement les disques cloud chiffrés. Valeurs possibles :
Valeur par défaut : false. |
DryRun | Boolean | Non | false | Indique s'il faut effectuer uniquement une vérification à blanc (dry run) sans exécuter la requête réelle. Valeurs possibles :
Valeur par défaut : false. |
KMSKeyId | String | Non | 0e478b7a-4262-4802-b8cb-00d3fb40**** | ID de la clé Key Management Service (KMS) utilisée par le disque cloud. |
MultiAttach | String | Non | Disabled | Indique si la fonctionnalité de montage multiple (multi-attach) est activée. Valeurs possibles :
La fonctionnalité de montage multiple est en phase de test sur invitation. Pour l'utiliser, soumettez un ticket. |
Tag.N.key | String | Non | null | Clé du tag N associé au disque. Remarque Nous vous recommandons d'utiliser l'autre paramètre Tag.N.Key afin de garantir la compatibilité. |
Tag.N.Key | String | Non | TestKey | Clé du tag N associé au disque. Valeurs possibles pour N : de 1 à 20. Si un seul tag est spécifié pour interroger les ressources, jusqu'à 1 000 ressources portant ce tag sont renvoyées. Si plusieurs tags sont spécifiés, jusqu'à 1 000 ressources portant tous ces tags sont renvoyées. Pour interroger plus de 1 000 ressources avec les tags spécifiés, appelez l'opération ListTagResources. |
Tag.N.Value | String | Non | TestValue | Valeur du tag N associé au disque. Valeurs possibles pour N : de 1 à 20. |
Tag.N.value | String | Non | null | Valeur du tag N associé au disque. Remarque Nous vous recommandons d'utiliser l'autre paramètre Tag.N.Value afin de garantir la compatibilité. |
AdditionalAttributes.N | String | Non | IOPS | Valeur de l'attribut N. Définissez la valeur sur IOPS, ce qui indique le nombre maximal d'opérations d'entrée/sortie par seconde (IOPS) du disque. |
Paramètres de réponse
Paramètre | Type | Exemple | Description |
NextToken | String | AAAAAdDWBF2**** | Jeton de requête renvoyé lors de cet appel. |
PageSize | Integer | 1 | Nombre d'entrées par page. |
PageNumber | Integer | 1 | Numéro de la page. |
RequestId | String | 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E | ID de la requête. |
TotalCount | Integer | 15 | Nombre total d'entrées renvoyées. |
Disks | Array of Disk | Détails relatifs aux disques. | |
Disk | |||
SerialNumber | String | bp18um4r4f2fve2**** | Numéro de série du disque. |
CreationTime | String | 2021-06-07T06:08:54Z | Date et heure de création du disque. |
Status | String | In_use | État du disque cloud. Valeurs possibles :
|
Type | String | system | Type de disque. Valeurs possibles :
|
PerformanceLevel | String | PL0 | Niveau de performance du disque ESSD. Valeurs possibles :
|
BdfId | String | null | Ce paramètre est en aperçu sur invitation et n'est pas disponible publiquement. |
EnableAutoSnapshot | Boolean | false | Indique si la fonction de stratégie de snapshot automatique est activée pour le disque cloud. |
StorageSetId | String | ss-i-bp1j4i2jdf3owlhe**** | ID du groupe de stockage. |
StorageSetPartitionNumber | Integer | 11 | Nombre maximal de partitions dans le groupe de stockage. |
DiskId | String | d-bp18um4r4f2fve24**** | ID du disque. |
DeleteAutoSnapshot | Boolean | false | Indique si les snapshots automatiques du disque cloud sont supprimés lors de la libération du disque. Valeurs possibles :
Les snapshots créés depuis la console ECS ou via l'opération CreateSnapshot sont conservés et ne sont pas affectés par ce paramètre. |
StorageClusterId | String | dbsc-j5e1sf2vaf5he8m2**** | ID du cluster de stockage par bloc dédié auquel appartient le disque cloud. Si votre disque cloud appartient au cluster de stockage par bloc public, une valeur vide est renvoyée. |
Encrypted | Boolean | false | Indique si le disque cloud est chiffré. |
IOPSRead | Integer | 2000 | Nombre maximal d'opérations de lecture d'E/S par seconde. |
MountInstanceNum | Integer | 1 | Nombre d'instances auxquelles le dispositif Shared Block Storage est attaché. |
Description | String | testDescription | Description du disque. |
Device | String | /dev/xvdb | Nom du périphérique du disque sur l'instance associée. Exemple : /dev/xvdb. Tenez compte des éléments suivants :
Remarque Ce paramètre sera déprécié. Nous vous recommandons d'utiliser d'autres paramètres afin de garantir la compatibilité. |
DiskName | String | testDiskName | Nom du disque. |
Portable | Boolean | false | Indique si le disque est amovible. |
ImageId | String | m-bp13aqm171qynt3u*** | ID de l'image utilisée pour créer l'instance. Ce paramètre reste vide sauf si le disque cloud est créé à partir d'une image. La valeur de ce paramètre demeure inchangée tout au long du cycle de vie du disque cloud. |
KMSKeyId | String | 0e478b7a-4262-4802-b8cb-00d3fb408*** | ID de la clé KMS utilisée par le disque cloud. |
DeleteWithInstance | Boolean | true | Indique si le disque cloud est libéré lorsque l'instance associée est libérée. Valeurs possibles :
|
DetachedTime | String | 2021-06-07T21:01:22Z | Date et heure de la dernière détachement du disque cloud. |
SourceSnapshotId | String | s-bp67acfmxazb4p**** | ID du snapshot utilisé pour créer le disque cloud. Ce paramètre reste vide sauf si le disque cloud est créé à partir d'un snapshot. La valeur de ce paramètre demeure inchangée tout au long du cycle de vie du disque cloud. |
AutoSnapshotPolicyId | String | sp-bp67acfmxazb4p**** | ID de la stratégie de snapshot automatique appliquée au disque cloud. |
EnableAutomatedSnapshotPolicy | Boolean | false | Indique si une stratégie de snapshot automatique est appliquée au disque cloud. |
IOPSWrite | Integer | 2000 | Nombre maximal d'opérations d'écriture par seconde. |
InstanceId | String | i-bp67acfmxazb4q**** | ID de l'instance à laquelle le disque est attaché. Tenez compte des éléments suivants :
|
IOPS | Integer | 4000 | Nombre maximal d'IOPS. |
RegionId | String | cn-hangzhou | ID de la région du disque. |
ExpiredTime | String | 2021-07-07T16:00Z | Date et heure d'expiration du disque cloud sous abonnement. |
Size | Integer | 60 | Taille du disque. Unité : GiB. |
ResourceGroupId | String | rg-bp67acfmxazb4p**** | ID du groupe de ressources auquel appartient le disque. |
DiskChargeType | String | PrePaid | Mode de facturation du disque. Valeurs acceptées :
|
ZoneId | String | cn-hangzhou-i | ID de la zone où se trouve le disque. |
AttachedTime | String | 2021-06-07T06:08:56Z | Date et heure de la dernière association du disque cloud. Le format suit la norme ISO 8601 (aaaa-MM-jjThh:mmZ) et l'heure est exprimée en UTC. |
Category | String | cloud_ssd | Catégorie du disque. Valeurs acceptées :
|
ProductCode | String | jxsc000204 | Code produit sur Alibaba Cloud Marketplace. |
MultiAttach | String | Disabled | Indique si la fonctionnalité d'association multiple est activée pour le disque cloud. |
OperationLocks | Array of OperationLock | Raisons pour lesquelles le disque est verrouillé. | |
OperationLock | |||
LockReason | String | security | Motif de sécurité ayant entraîné le verrouillage du disque. |
MountInstances | Array of MountInstance | Informations d'association du dispositif Shared Block Storage. | |
MountInstance | |||
AttachedTime | String | 2017-12-05T2340:00Z | Date et heure de l'association. Le format suit la norme ISO 8601 (aaaa-MM-jjTHH:mm:ssZ) et l'heure est exprimée en UTC. |
InstanceId | String | i-bp1j4i2jdf3owlhe**** | ID de l'instance à laquelle le disque est associé. |
Device | String | /dev/xvda | Point de montage du disque. |
Tags | Array of Tag | Tags associés au disque. | |
Tag | |||
TagValue | String | TestValue | Valeur du tag associé au disque. |
TagKey | String | TestKey | Clé du tag associé au disque. |
Attachments | Array of Attachment | Informations d'association du disque cloud. La valeur est un tableau composé des valeurs | |
Attachment | |||
InstanceId | String | i-bp67acfmxazb4q**** | ID de l'instance à laquelle le disque est associé. |
Device | String | /dev/xvda | Nom du périphérique du disque. |
AttachedTime | String | 2021-06-07T06:08:56Z | Date et heure de l'association. L'heure est exprimée en UTC. |
ProvisionedIops | Long | 40000 | Nombre d'IOPS en lecture/écriture provisionnés pour le disque ESSD AutoPL. Valeurs acceptées : 0 à min{50 000, 1 000 × Capacité - IOPS de base}. Performances de base = min{1 800 + 50 × Capacité, 50 000} Ce paramètre est pris en charge uniquement si le paramètre |
BurstingEnabled | Boolean | false | Indique si la fonctionnalité de burst de performances est activée. Valeurs acceptées :
Ce paramètre est pris en charge uniquement si le paramètre |
Throughput | Integer | 100 | Volume de données transférées par seconde. Unité : Mo/s. |
ThroughputRead | Integer | 100 | Volume de données lues par le système par seconde. Unité : Mo/s. |
ThroughputWrite | Integer | 100 | Volume de données écrites par le système par seconde. Unité : Mo/s. |
Exemples
Exemple de requête
https://ecs.aliyuncs.com/?Action=DescribeDisks
&RegionId=cn-hangzhou
&PageNumber=1
&PageSize=1
&<Common request parameters>
Exemple de réponse en cas de succès
Format XML
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeDisksResponse>
<TotalCount>15</TotalCount>
<NextToken>AAAAAdDWBF2****</NextToken>
<PageSize>1</PageSize>
<RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
<PageNumber>1</PageNumber>
<Disks>
<Disk>
<DetachedTime/>
<Category>cloud_ssd</Category>
<Description>testDescription</Description>
<KMSKeyId/>
<ResourceGroupId/>
<DedicatedBlockStorageClusterId/>
<Encrypted>false</Encrypted>
<Size>40</Size>
<DeleteAutoSnapshot>false</DeleteAutoSnapshot>
<DiskChargeType>PrePaid</DiskChargeType>
<MultiAttach>Disabled</MultiAttach>
<Attachments>
<Attachment>
<AttachedTime>2021-06-07T06:08:56Z</AttachedTime>
<InstanceId>i-bp67acfmxazb4q****</InstanceId>
<Device>/dev/xvda</Device>
</Attachment>
</Attachments>
<ExpiredTime>2021-07-07T16:00Z</ExpiredTime>
<ImageId>m-bp13aqm171qynt3u***</ImageId>
<StorageSetId/>
<Tags>
</Tags>
<Status>In_use</Status>
<AttachedTime>2021-06-07T06:08:56Z</AttachedTime>
<StorageClusterId>dbsc-j5e1sf2vaf5he8m2****</StorageClusterId>
<ZoneId>cn-hangzhou-i</ZoneId>
<InstanceId>i-bp67acfmxazb4q****</InstanceId>
<SourceSnapshotId/>
<ProductCode/>
<PerformanceLevel>PL0</PerformanceLevel>
<Device>/dev/xvdb</Device>
<DeleteWithInstance>true</DeleteWithInstance>
<EnableAutomatedSnapshotPolicy>false</EnableAutomatedSnapshotPolicy>
<EnableAutoSnapshot>false</EnableAutoSnapshot>
<AutoSnapshotPolicyId>sp-bp67acfmxazb4p****</AutoSnapshotPolicyId>
<DiskName>testDiskName</DiskName>
<OperationLocks>
</OperationLocks>
<BdfId/>
<Portable>false</Portable>
<Type>system</Type>
<SerialNumber>bp18um4r4f2fve2****</SerialNumber>
<CreationTime>2021-06-07T06:08:54Z</CreationTime>
<RegionId>cn-hangzhou</RegionId>
<DiskId>d-bp18um4r4f2fve24****</DiskId>
</Disk>
</Disks>
</DescribeDisksResponse>
Format JSON
HTTP/1.1 200 OK
Content-Type:application/json
{
"TotalCount" : 15,
"NextToken" : "AAAAAdDWBF2****",
"PageSize" : 1,
"RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"PageNumber" : 1,
"Disks" : {
"Disk" : [ {
"DetachedTime" : "",
"Category" : "cloud_ssd",
"Description" : "testDescription",
"KMSKeyId" : "",
"ResourceGroupId" : "",
"DedicatedBlockStorageClusterId" : "",
"Encrypted" : false,
"Size" : 40,
"DeleteAutoSnapshot" : false,
"DiskChargeType" : "PrePaid",
"MultiAttach" : "Disabled",
"Attachments" : {
"Attachment" : [ {
"AttachedTime" : "2021-06-07T06:08:56Z",
"InstanceId" : "i-bp67acfmxazb4q****",
"Device" : "/dev/xvda"
} ]
},
"ExpiredTime" : "2021-07-07T16:00Z",
"ImageId" : "m-bp13aqm171qynt3u***",
"StorageSetId" : "",
"Tags" : {
"Tag" : [ ]
},
"Status" : "In_use",
"AttachedTime" : "2021-06-07T06:08:56Z",
"StorageClusterId" : "dbsc-j5e1sf2vaf5he8m2****",
"ZoneId" : "cn-hangzhou-i",
"InstanceId" : "i-bp67acfmxazb4q****",
"SourceSnapshotId" : "",
"ProductCode" : "",
"PerformanceLevel" : "PL0",
"Device" : "/dev/xvdb",
"DeleteWithInstance" : true,
"EnableAutomatedSnapshotPolicy" : false,
"EnableAutoSnapshot" : false,
"AutoSnapshotPolicyId" : "sp-bp67acfmxazb4p****",
"DiskName" : "testDiskName",
"OperationLocks" : {
"OperationLock" : [ ]
},
"BdfId" : "",
"Portable" : false,
"Type" : "system",
"SerialNumber" : "bp18um4r4f2fve2****",
"CreationTime" : "2021-06-07T06:08:54Z",
"RegionId" : "cn-hangzhou",
"DiskId" : "d-bp18um4r4f2fve24****"
} ]
}
}
Codes d'erreur
|
Code d'état HTTP |
Code d'erreur |
Message d'erreur |
Description |
|
400 |
InvalidDiskType.ValueNotSupported |
The specified disk type is not supported. |
Type de disque non valide. |
|
400 |
InvalidCategory.ValueNotSupported |
The specified disk category is not supported. |
Catégorie de disque non valide. |
|
400 |
InvalidStatus.ValueNotSupported |
The specified disk status is not supported. |
L'opération ne peut pas être effectuée sur le disque dans son état actuel. |
|
400 |
InvalidTag.Mismatch |
The specified Tag.n.Key and Tag.n.Value are not match. |
Les paramètres Tag.N.Key et Tag.N.Value spécifiés ne correspondent pas. |
|
400 |
InvalidTagCount |
The specified tags are beyond the permitted range. |
Le nombre maximal de tags est dépassé. |
|
400 |
InvalidRegion.NotFound |
The specified parameter RegionId is not valid. |
Valeur RegionId non valide. |
|
400 |
InvalidZoneId.NotFound |
The zoneId provided does not exist in our records. |
L'ID de zone spécifié est introuvable. |
|
400 |
MissingParamter.RegionId |
The regionId should not be null. |
Le paramètre RegionId est obligatoire. |
|
400 |
InvalidParameter.DiskIds |
The specified parameter diskIds is not valid. |
Valeur DiskIds non valide. |
|
400 |
IncompleteParamter |
Some fields can not be null in this request. |
Un paramètre requis n'est pas spécifié. |
|
400 |
InvalidParamter |
Some parameters are invalid in this request. |
La requête contient des paramètres non valides. |
|
400 |
InvalidSnapshot.NotFound |
The specified parameter SnapshotId is not valid. |
Valeur SnapshotId non valide. |
|
403 |
InvalidDiskIds.Malformed |
The amount of specified disk Ids exceeds the limit. |
Valeur DiskIds non valide. |
|
403 |
UserNotInTheWhiteList |
The user is not in volume white list. |
Vous n'êtes pas autorisé à gérer le dispositif Shared Block Storage. Soumettez un ticket pour demander les autorisations. |
|
403 |
InvalidParameter.MultiAttachAndEnableSharedNotMatch |
The parameter MultiAttach and EnableShared are not match. |
Les paramètres MultiAttach et EnableShared spécifiés ne correspondent pas. |
|
403 |
InvalidParameter.MultiAttach |
The specified param MultiAttach is not valid. |
Valeur MultiAttach non valide. |
|
404 |
InvalidDiskChargeType.NotFound |
The DiskChargeType does not exist in our records |
Le DiskChargeType est introuvable. |
|
404 |
InvalidLockReason.NotFound |
The specified LockReason is not found |
Le LockReason est introuvable. |
|
500 |
InternalError |
The request processing has failed due to some unknown error. |
Une erreur interne s'est produite. Réessayez ultérieurement. |
Pour obtenir la liste des codes d'erreur, consultez la page Codes d'erreur du service.