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

Cloud Parallel File Storage (CPFS) ファイルシステムのプロトコルサービスを作成します。作成プロセスには約 5 ～ 10 分かかります。

操作説明

この操作は CPFS ファイルシステムにのみ適用されます。
CPFS 2.3.0 以降のみがプロトコルサービスをサポートしています。 DescribeFileSystems 操作を呼び出して、ファイルシステムのバージョンをクエリできます。
プロトコルサービスのスペック。

プロトコルサービスには、General と Cache の 2 つのプロトコルの種類があります。General タイプと比較して、Cache タイプはホットスポットデータキャッシングを提供します。キャッシュがヒットすると、Cache タイプのプロトコルサービスの帯域幅は CPFS ファイルシステムの帯域幅を超え、プロトコルサービスに設定された最大値の帯域幅に達することができます。
- General: CPFS の NFS プロトコルアクセスとフォルダレベルのマウントターゲットを提供します。POSIX クライアントのクラスター管理を設定する必要はありません。この特徴は無料です。
- Cache: General タイプの機能に加えて、LRU ポリシーに基づくサーバー側のメモリキャッシングを提供します。データがメモリにキャッシュされると、CPFS はより高い内部ネットワーク帯域幅を提供できます。Cache タイプのプロトコルサービスには、Cache L1 と Cache L2 の 2 つのスペックがあり、内部ネットワーク帯域幅とメモリキャッシュサイズが異なります。
説明
Cache タイプのプロトコルサービスは有料サービスであり、招待プレビュー中です。Cache タイプのプロトコルサービスの課金については、課金項目を参照してください。フィードバックや質問がある場合は、DingTalk ユーザーグループ (グループ ID: 31045006299) に参加して CPFS エンジニアとコミュニケーションしてください。
プロトコルの種類。

NFSv3 のみがサポートされています。
前提条件。

CPFS ファイルシステムが作成済みで、実行中ステータスである必要があります。
その他の情報。
- 各 CPFS ファイルシステムに対して作成できるプロトコルサービスは 1 つのみです。
- プロトコルサービスの作成時に、指定された vSwitch の IP アドレスを消費します (最大 32 個の IP アドレス)。ターゲットの vSwitch に十分な IP アドレスリソースがあることを確認してください。

今すぐお試しください

この 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:CreateProtocolService

create

*FileSystem

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
FileSystemId	string	必須	ファイルシステム ID。	cpfs-099394bd928c****
ProtocolSpec	string	必須	プロトコルサービスのスペック。有効な値: General (デフォルト)。列挙値: CL2 : Cache L2。 General : General。 CL1 : Cache L1。	General
Throughput	integer	任意	プロトコルサービスの帯域幅。単位: MB/s。	8000
ProtocolType	string	必須	プロトコルサービスのプロトコルの種類。有効な値: NFS (デフォルト)。NFSv3 アクセスのみがサポートされています。	NFS
Description	string	任意	プロトコルサービスの説明。この値はコンソールで「プロトコルサービス名」として表示されます。使用制限: 説明は 2 ～ 128 文字である必要があります。説明は英字または中国語文字で始まる必要があり、`http://` または `https://` で始めることはできません。説明には数字、コロン (:)、アンダースコア (_)、ハイフン (-) を含めることができます。	此协议服务的描述。
VpcId	string	任意	プロトコルサービスの VPC ID。VPC はファイルシステムの VPC と同じである必要があります。ファイルシステムのストレージの冗長性タイプがゾーン冗長ストレージ (ZRS) の場合、このパラメーターを設定しないでください。それ以外の場合、このパラメーターは必須です。	vpc-2vct297b8157bth9z****
VSwitchId	string	任意	プロトコルサービスの vSwitch ID。ファイルシステムのストレージの冗長性タイプがゾーン冗長ストレージ (ZRS) の場合、このパラメーターを設定しないでください。それ以外の場合、このパラメーターは必須です。	vsw-2vc3c2lybvdllxyq4****
DryRun	boolean	任意	このリクエストに対してドライランを実行するかどうかを指定します。ドライランは、実際にインスタンスを作成したり課金を発生させたりすることなく、パラメーターの有効性と依存関係をチェックします。有効な値: true: プロトコルサービスを作成せずにチェックリクエストを送信します。チェック項目には、必須パラメーターが指定されているかどうか、リクエストのフォーマット、ビジネス制限の依存関係が含まれます。チェックが失敗した場合、対応するエラーが返されます。チェックが成功した場合、HTTP 状態コード 200 が返されますが、ProtocolServiceId は空です。 false (デフォルト): 通常のリクエストを送信します。チェックが成功すると、インスタンスが直接作成されます。	false
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認してください。トークンには ASCII 文字のみを含めることができ、64 文字を超えることはできません。詳細については、べき等性の確保方法を参照してください。説明このパラメーターを指定しない場合、システムは API リクエストの RequestId を ClientToken として自動的に使用します。RequestId は API の呼び出しごとに異なる場合があります。	123e4567-e89b-12d3-a456-42665544****

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスのスキーマ。
RequestId	string	リクエスト ID。	98696EF0-1607-4E9D-B01D-F20930B6****
ProtocolServiceId	string	プロトコルサービスクラスター ID。	ptc-197ed6a00f2b****

例

成功レスポンス

JSONJSON

{
  "RequestId": "98696EF0-1607-4E9D-B01D-F20930B6****",
  "ProtocolServiceId": "ptc-197ed6a00f2b****"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	MissingFileSystemId	FileSystemId is mandatory for this action.
400	MissingVpcId	VpcId is mandatory for this action.
400	MissingVSwitchId	VSwitchId is mandatory for this action.
403	InvalidProtocolSpec.NotSupported	The specified protocol spec does not supported.
403	InvalidNetworkType.NotSupported	The specified network type does not supported.
403	Instance.IncorrectStatus	The specified instance is in an incorrect status.
403	OperationDenied.ProtocolServiceExceedLimit	The protocol service amount exceed file system limit.
403	PermissionDenied.CapacityTooLow	Capacity of file system too low to subscribe protocol service.
403	PermissionDenied.ThroughputInvalid	Standard protocol service should not specified throughput.
403	PermissionDenied.ThroughputTooSmall	Throughput of protocol service too small.
403	PermissionDenied.ThroughputExceed	Throughput of protocol service must less than throughput of file system.
403	InvalidProtocolType.NotSupported	The specified protocol type does not supported.
403	InvalidVSwitchId.IpShortage	The specified vswitch ip shortage.
403	InvalidFset.InUse	Fset already used by other export.
403	InvalidFileSystemPath.InvalidCharacters	The specified filesystem path contains invalid characters.
403	MntPathConflict.InvalidParam	FilesetId and Path must and can only be specified one.
403	OperationDenied.TooManyDepth	The operation is denied due to Fsets path too deep.
403	OperationDenied.InvalidState	The operation is denied due to invalid file system state.
403	OperationDenied.NoProtocolServiceQuota	No protocol service quota.
403	OperationDenied.NotSupported	The operation is denied due to not supported.
403	PermissionDenied.CLThroughputInvalid	Throughput of caching protocol service is invalid.
403	InvalidVpcId.CrossVpcNotSupport.	Cross VPC not support.
404	InvalidParameter.VpcNotFound	The specified VPC does not exist.
404	InvalidParameter.VswNotFound	The specified VSwitch does not exist.
404	InvalidFileSystem.NotFound	The specified file system does not exist.
404	InvalidDescription.InvalidFormat	Description format is invalid.
404	InvalidVpcId.ConflictVpcCidr	Vpc cidr conflict with file system
404	InvalidAccessGroupName.NotFound	The specified access group does not exist.
404	InvalidAccessGroupName.NotAccessRule	There has no rule in access group.
404	OperationDenied.NoStock	The operation is denied due to no stock.
404	PathNotExistInFileSystem.InvalidParam	Given path does not exist in file system.
404	InvalidFsetId.NotFound	The specified Fileset ID does not exist.
404	InvalidParameter.VpcVswitchMismatch	Given vSwitch mismatch with given VPC.

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

変更履歴

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