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

プロトコルサービスのエクスポートディレクトリを照会します。

操作説明

この操作は、Cloud Parallel File Storage (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:DescribeProtocolMountTarget

list

*FileSystem

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
NextToken	string	任意	応答が切り捨てられた場合に、次のリクエストを開始するために使用されるトークンです。このトークンを使用して、切り捨てが発生した位置から残りの結果を取得できます。	aBcdg==
MaxResults	integer	任意	クエリごとに返す結果の最大値。有効な値: 10 ～ 100。デフォルト値: 20。	20
FileSystemId	string	必須	ファイルシステムの ID。	cpfs-099394bd928c****
Filters	array<object>	任意	プロトコルサービスのエクスポートディレクトリをクエリするためのフィルターキー。
	object	任意	プロトコルサービスのエクスポートディレクトリをクエリするためのフィルターキー。
Key	string	任意	フィルターキーの名前。 ProtocolServiceIds: プロトコルサービス ID でフィルタリングします。 ExportIds: エクスポートディレクトリ ID でフィルタリングします。 VpcIds: VPC ID でフィルタリングします。 FsetIds: ファイルセット ID でフィルタリングします。 Paths: マウントポイントに対応するファイルシステムパスでフィルタリングします。 AccessGroupNames: 権限グループ名でフィルタリングします。	ExportIds
Value	string	任意	フィルターキーの値。ワイルドカードはサポートされていません。 Key が ProtocolServiceIds に設定されている場合、Value をプロトコルサービス ID に設定します。最大 10 個のプロトコルサービス ID を指定できます。例: `ptc-12345678` または `ptc-12345678,ptc-12345679`。 Key が ExportIds に設定されている場合、Value をエクスポートディレクトリ ID に設定します。最大 10 個のエクスポートディレクトリ ID を指定できます。例: `exp-12345678` または `exp-12345678,exp-12345679`。 Key が VpcIds に設定されている場合、Value をプロトコルサービスの VPC ID に設定します。最大 10 個の VPC ID を指定できます。例: `vpc-12345678` または `vpc-12345678,vpc-12345679`。 Key が FsetIds に設定されている場合、Value をファイルセット ID に設定します。最大 10 個のファイルセット ID を指定できます。例: `fset-12345678` または `fset-12345678,fset-12345679`。 Key が Paths に設定されている場合、Value をマウントポイントに対応するファイルシステムディレクトリに設定します。最大 10 個のパスを指定できます。例: `/cpfs/mnt_1/` または `/cpfs/mnt_1/,/cpfs/mnt_2/`。 Key が AccessGroupNames に設定されている場合、Value をプロトコルサービスの権限グループ名に設定します。最大 10 個の権限グループ名を指定できます。例: `ag-12345678` または `ag-12345678,ag-12345679`。	exp-19abf5beab8d**, exp-19acf6beaf7d**
ClientToken	string	任意	リクエストのべき等性を確保します。クライアントから一意のパラメーター値を生成し、異なるリクエスト間で値が一意であることを確認してください。 ClientToken は ASCII 文字のみをサポートし、長さは 64 文字を超えることはできません。詳細については、「べき等性を確保する方法」を参照してください。説明このパラメーターを指定しない場合、システムは API リクエストの RequestId を ClientToken として使用します。RequestId は API リクエストごとに異なる場合があります。	123e4567-e89b-12d3-a456-42665544****
ProtocolServiceIds	string	任意	プロトコルサービス ID のリスト。	ptc-123xxx

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスのスキーマ。
RequestId	string	リクエストの ID。	473469C7-AA6F-4DC5-B3DB-A3DC0****
NextToken	string	後続のクエリで残りのエクスポートディレクトリを取得するために使用されるマーカー。	aBcdeg==
ProtocolMountTargets	array<object>	プロトコルサービスのエクスポートディレクトリのコレクション。
	object	プロトコルサービスのエクスポートディレクトリ。
ExportId	string	プロトコルサービスのエクスポートディレクトリの ID。	exp-19abf5beab8d****
ProtocolMountTargetDomain	string	プロトコルサービスのエクスポートディレクトリのドメイン名。	cpfs-123****.cn-hangzhou.cpfs.aliyuncs.com
ProtocolType	string	プロトコルサービスでサポートされるプロトコルの種類。	NFS
VpcId	string	プロトコルサービスのエクスポートディレクトリの VPC ID。	vpc-2vct297b8157bth9z****
VSwitchId	string	プロトコルサービスのエクスポートディレクトリの vSwitch ID。	vsw-2vc3c2lybvdllxyq4****
FsetId	string	プロトコルサービスのエクスポートディレクトリのファイルセット ID。	fset-1902718ea0ae****
Path	string	プロトコルサービスのエクスポート済みディレクトリ。	/path/
AccessGroupName	string	プロトコルサービスのエクスポートディレクトリに関連付けられた権限グループ。	DEFAULT_VPC_GROUP_NAME
CreateTime	string	プロトコルサービスのエクスポートディレクトリが作成された時間。時間は ISO 8601 標準に従い、yyyy-MM-ddTHH:mm:ssZ フォーマットです。	2018-12-12T07:28:38Z
Status	string	マウントポイントのステータス。	CREATING
ProtocolServiceId	string	プロトコルサービスの ID。	ptc-123****
Description	string	プロトコルサービスのエクスポートディレクトリの説明。	此协议服务导出目录的描述。
VSwitchIds	array	ゾーン冗長 vSwitch ID のリスト。
	string	ゾーン冗長 vSwitch ID のリスト。	vsw-123xxx

例

成功レスポンス

JSONJSON

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0****",
  "NextToken": "aBcdeg==",
  "ProtocolMountTargets": [
    {
      "ExportId": "exp-19abf5beab8d****",
      "ProtocolMountTargetDomain": "cpfs-123****.cn-hangzhou.cpfs.aliyuncs.com",
      "ProtocolType": "NFS",
      "VpcId": "vpc-2vct297b8157bth9z****",
      "VSwitchId": "vsw-2vc3c2lybvdllxyq4****",
      "FsetId": "fset-1902718ea0ae****",
      "Path": "/path/",
      "AccessGroupName": "DEFAULT_VPC_GROUP_NAME",
      "CreateTime": "2018-12-12T07:28:38Z",
      "Status": "CREATING",
      "ProtocolServiceId": "ptc-123****",
      "Description": "此协议服务导出目录的描述。",
      "VSwitchIds": [
        "vsw-123xxx"
      ]
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	MissingFileSystemId	FileSystemId is mandatory for this action.	FileSystemId パラメーターが指定されていません。
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.	指定された MaxResults が無効です。
404	InvalidFilterValue	The specified Filter.N.Value is invalid.	指定された Filter.N.Value パラメーターが無効です。
404	InvalidFilterParam	The specified Filter.N.Key is invalid.	指定された Filter.N.Key パラメーターが無効です。

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

変更履歴

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