DescribeProtocolService - Cloud Parallel File Storage - Alibaba Cloud ドキュメントセンター

プロトコルサービスの情報を照会します。

操作説明

このインターフェイスは CPFS ファイルシステムにのみ適用されます。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

nas:DescribeProtocolService

list

*FileSystem

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ProtocolServiceIds	string	任意	プロトコルサービスの ID。フォーマット：CSV。制限：最大 10 個のプロトコルサービス ID を指定できます。	ptc-197ed6a00f2b**,ptc-196ed6a00f2b**
Status	string	任意	プロトコルサービスのステータス。フォーマット：CSV。有効な値： Creating：プロトコルサービスは作成中です。 Starting：プロトコルサービスは起動中です。 Running：プロトコルサービスは実行中です。 Updating：プロトコルサービスは更新中です。 Deleting：プロトコルサービスは削除中です。 Stopping：プロトコルサービスは停止中です。 Stopped：プロトコルサービスは停止しています。	Running,Updating
NextToken	string	任意	次のリクエストで結果の新しいページを取得するために使用されるページネーショントークンです。最初のリクエストでは、このパラメーターを指定する必要はありません。前のクエリから取得したトークンを NextToken の値として指定する必要があります。	aBcdg==
MaxResults	integer	任意	各クエリの結果数。最大値：100。最小値：10。デフォルト値：20。	20
FileSystemId	string	必須	ファイルシステムの ID。	cpfs-099394bd928c****
Description	string	任意	プロトコルサービスの説明、または説明の一部。制限事項：説明は 2～128 文字である必要があります。説明は文字で始まる必要があり、`http://` または `https://` で始めることはできません。説明には、文字、数字、コロン (:)、アンダースコア (_)、ハイフン (-) を使用できます。	此协议服务的描述
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。トークンには ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。詳細については、「べき等性を保証する方法」をご参照ください。説明このパラメーターを指定しない場合、システムは自動的にリクエスト ID をクライアントトークンとして使用します。リクエスト ID はリクエストごとに異なる場合があります。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスのスキーマ
RequestId	string	リクエスト ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
NextToken	string	ページネーショントークン。次のリクエストで使用して、結果の新しいページを取得できます。	aBcdeg==
ProtocolServices	array<object>	プロトコルサービスリストに関する情報。
	object	プロトコルサービスに関する情報。
FileSystemId	string	ファイルシステムの ID。	cpfs-099394bd928c****
ProtocolServiceId	string	プロトコルサービスの ID。	ptc-197ed6a00f2b****
ProtocolSpec	string	プロトコルサービスの仕様。有効な値：General。デフォルト値：General。	General
ProtocolThroughput	integer	プロトコルサービスのスループット。単位：MB/s。	500
InstanceRAM	integer	プロトコルサービスのメモリキャッシュサイズ。単位：GiB。	0
InstanceBaseThroughput	integer	プロトコルサービスのベーススループット。単位：MB/s。	100
InstanceBurstThroughput	integer	プロトコルサービスのバーストスループット。単位：MB/s。	100
MountTargetCount	integer	プロトコルサービスでエクスポートされた CPFS ディレクトリとファイルセットの合計数。	5
ProtocolType	string	プロトコルサービスでサポートされているプロトコルタイプ。有効な値： NFS：プロトコルサービスは、ネットワークファイルシステム (NFS) プロトコル経由のアクセスをサポートします。	NFS
Status	string	プロトコルサービスのステータス。有効な値： Creating：プロトコルサービスは作成中です。 Starting：プロトコルサービスは起動中です。 Running：プロトコルサービスは実行中です。 Updating：プロトコルサービスは更新中です。 Deleting：プロトコルサービスは削除中です。 Stopping：プロトコルサービスは停止中です。 Stopped：プロトコルサービスは停止しています。	Running
Description	string	プロトコルサービスの説明。制限事項：説明は 2～128 文字である必要があります。説明は文字で始まる必要があり、`http://` または `https://` で始めることはできません。説明には、文字、数字、コロン (:)、アンダースコア (_)、ハイフン (-) を使用できます。	此协议服务的描述
CreateTime	string	プロトコルサービスが作成された時刻。時刻は協定世界時 (UTC) で表示されます。	2018-12-12T07:28:38Z
ModifyTime	string	プロトコルサービスが変更された時刻。時刻は協定世界時 (UTC) で表示されます。	2018-12-12T07:28:38Z
VpcId	string	プロトコルサービスに関連付けられている VPC ID。	vpc-123xxx
VSwitchId	string	プロトコルサービスに関連付けられている VSW ID。	vsw-123xxx

例

成功レスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
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.
404	InvalidParameter.InvalidNextToken	The specified NextToken is invaild.
404	InvalidParameter.InvalidMaxResults	The specified MaxResults is invalid.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。