DescribeProtocolService - Cloud Parallel File Storage - Centre de documentation Alibaba Cloud

Consulte les informations sur les services de protocole.

Description de l'opération

Cette API s'applique uniquement aux systèmes de fichiers CPFS.

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.

nas:DescribeProtocolService

list

*FileSystem

acs:nas:{#regionId}:{#accountId}:filesystem/{#FileSystemId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
ProtocolServiceIds	string	Non	Les identifiants des services de protocole. Format : CSV. Limite : vous pouvez spécifier un maximum de 10 identifiants de services de protocole.	ptc-197ed6a00f2b**,ptc-196ed6a00f2b**
Status	string	Non	L'état du service de protocole. Format : CSV. Valeurs valides : Creating : le service de protocole est en cours de création. Starting : le service de protocole est en cours de démarrage. Running : le service de protocole est en cours d'exécution. Updating : le service de protocole est en cours de mise à jour. Deleting : le service de protocole est en cours de suppression. Stopping : le service de protocole est en cours d'arrêt. Stopped : le service de protocole est arrêté.	Running,Updating
NextToken	string	Non	Le jeton de pagination utilisé dans la requête suivante pour récupérer une nouvelle page de résultats. Vous n'avez pas besoin de spécifier ce paramètre pour la première requête. Vous devez spécifier le jeton obtenu lors de la requête précédente comme valeur de NextToken.	aBcdg==
MaxResults	integer	Non	Le nombre de résultats pour chaque requête. Valeur maximale : 100. Valeur minimale : 10. Valeur par défaut : 20.	20
FileSystemId	string	Oui	L'identifiant du système de fichiers.	cpfs-099394bd928c****
Description	string	Non	La description ou une partie de la description du service de protocole. Limites : La description doit comporter entre 2 et 128 caractères. La description doit commencer par une lettre et ne peut pas commencer par `http://` ou `https://`. La description peut contenir des lettres, des chiffres, des deux-points (:), des traits de soulignement (_) et des traits d'union (-).	Description de ce service de protocole
ClientToken	string	Non	Le jeton client utilisé pour garantir l'idempotence de la requête. Vous pouvez utiliser le client pour générer le jeton, mais vous devez vous assurer que le jeton est unique pour chaque requête. Le jeton ne peut contenir que des caractères ASCII et ne doit pas dépasser 64 caractères. Pour plus d'informations, consultez Comment garantir l'idempotence ? Remarque Si vous ne spécifiez pas ce paramètre, le système utilise automatiquement l'identifiant de la requête comme jeton client. L'identifiant de la requête peut être différent pour chaque requête.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Éléments de réponse

Élément	Type	Description	Exemple
	object	Schéma de la réponse.
RequestId	string	L'identifiant de la requête.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
NextToken	string	Un jeton de pagination. Il peut être utilisé dans la requête suivante pour récupérer une nouvelle page de résultats.	aBcdeg==
ProtocolServices	array<object>	Les informations sur la liste des services de protocole.
	object	Les informations sur le service de protocole.
FileSystemId	string	L'identifiant du système de fichiers.	cpfs-099394bd928c****
ProtocolServiceId	string	L'identifiant du service de protocole.	ptc-197ed6a00f2b****
ProtocolSpec	string	La spécification du service de protocole. Valeurs valides : General. Valeur par défaut : General.	General
ProtocolThroughput	integer	Le débit du service de protocole. Unité : Mo/s.	500
InstanceRAM	integer	La taille du cache mémoire du service de protocole. Unité : Gio.	0
InstanceBaseThroughput	integer	Le débit de base du service de protocole. Unité : Mo/s.	100
InstanceBurstThroughput	integer	Le débit de pointe du service de protocole. Unité : Mo/s.	100
MountTargetCount	integer	Le nombre total de répertoires et de jeux de fichiers CPFS exportés dans le service de protocole.	5
ProtocolType	string	Le type de protocole pris en charge par le service de protocole. Valeurs valides : NFS : le service de protocole prend en charge l'accès via le protocole Network File System (NFS).	NFS
Status	string	L'état du service de protocole. Valeurs valides : Creating : le service de protocole est en cours de création. Starting : le service de protocole est en cours de démarrage. Running : le service de protocole est en cours d'exécution. Updating : le service de protocole est en cours de mise à jour. Deleting : le service de protocole est en cours de suppression. Stopping : le service de protocole est en cours d'arrêt. Stopped : le service de protocole est arrêté.	Running
Description	string	La description du service de protocole. Limites : La description doit comporter entre 2 et 128 caractères. La description doit commencer par une lettre et ne peut pas commencer par `http://` ou `https://`. La description peut contenir des lettres, des chiffres, des deux-points (:), des traits de soulignement (_) et des traits d'union (-).	Description de ce service de protocole
CreateTime	string	L'heure à laquelle le service de protocole a été créé. L'heure est affichée en UTC.	2018-12-12T07:28:38Z
ModifyTime	string	L'heure à laquelle le service de protocole a été modifié. L'heure est affichée en UTC.	2018-12-12T07:28:38Z
VpcId	string	L'identifiant du VPC associé au service de protocole.	vpc-123xxx
VSwitchId	string	L'identifiant du VSW associé au service de protocole.	vsw-123xxx

Exemples

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "NextToken": "aBcdeg==",
  "ProtocolServices": [
    {
      "FileSystemId": "cpfs-099394bd928c****",
      "ProtocolServiceId": "ptc-197ed6a00f2b****",
      "ProtocolSpec": "General",
      "ProtocolThroughput": 500,
      "InstanceRAM": 0,
      "InstanceBaseThroughput": 100,
      "InstanceBurstThroughput": 100,
      "MountTargetCount": 5,
      "ProtocolType": "NFS",
      "Status": "Running",
      "Description": "此协议服务的描述",
      "CreateTime": "2018-12-12T07:28:38Z",
      "ModifyTime": "2018-12-12T07:28:38Z",
      "VpcId": "vpc-123xxx",
      "VSwitchId": "vsw-123xxx"
    }
  ]
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	MissingFileSystemId	FileSystemId is mandatory for this action.
400	InvalidParam.TooManyProtocolServiceIds	Too many protocol service ids given.
403	InvalidStatus.NotSupported	The specified protocol service status does not support.
404	InvalidFileSystem.NotFound	The specified file system does not exist.	The specified file system does not exist.
404	InvalidParameter.InvalidNextToken	The specified NextToken is invaild.
404	InvalidParameter.InvalidMaxResults	The specified MaxResults is invalid.

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

Notes de version

Consultez Notes de version pour la liste complète.