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

プロトコルサービスを変更します。この操作では、プロトコルサービスの説明を変更できます。

操作説明

この API は 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:ModifyProtocolService

update

*FileSystem

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ProtocolServiceId	string	必須	プロトコルサービス ID。	ptc-197ed6a00f2b****
FileSystemId	string	必須	ファイルシステム ID。	cpfs-099394bd928c****
Description	string	任意	プロトコルサービスの説明。制限事項：説明の長さは 2～128 文字にする必要があります。説明は英字で始める必要があり、`http://` または `https://` で始めることはできません。説明には、英字、数字、コロン (:)、アンダースコア (_)、ハイフン (-) を使用できます。	此协议服务的描述信息
DryRun	boolean	任意	実際のリクエストを実行せずに、ドライランのみを実行するかどうかを指定します。ドライランでは、パラメーターの有効性と前提条件がチェックされます。ドライランでは、ファイルシステムは変更されず、料金も発生しません。有効な値： true: ドライランのみを実行し、プロトコルサービスは変更しません。システムはリクエストのフォーマット、サービスの制限、前提条件、および必須パラメーターが指定されているかどうかをチェックします。リクエストがドライランに失敗した場合、エラーメッセージが返されます。リクエストがドライランに成功した場合、HTTP ステータスコード 200 が返されます。 false (デフォルト): ドライランを実行し、実際のリクエストも実行します。リクエストがドライランに成功した場合、サービスプロトコルが変更されます。	false
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。トークンは ASCII 文字のみで構成され、長さは 64 文字を超えることはできません。詳細については、「べき等性を確保する方法」をご参照ください。説明このパラメーターを指定しない場合、システムは自動的にリクエスト ID をクライアントトークンとして使用します。リクエスト ID はリクエストごとに異なる場合があります。	123e4567-e89b-12d3-a456-42665544****

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ
RequestId	string	リクエスト ID。	98696EF0-1607-4E9D-B01D-F20930B6****

例

成功レスポンス

JSONJSON

{
  "RequestId": "98696EF0-1607-4E9D-B01D-F20930B6****"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	MissingFileSystemId	FileSystemId is mandatory for this action.
400	MissingProtocolServiceId	ProtocolServiceId is mandatory for this action.
403	Instance.IncorrectStatus	The specified instance is in an incorrect status.
403	InvalidProtocolSpec.NotSupported	The specified protocol spec does not supported.
403	PermissionDenied.ThroughputInvalid	Standard protocol service should not specified throughput.
403	InvalidVSwitchId.IpShortage	The specified vswitch ip shortage.
403	OperationDenied.InvalidPtcStatus	The operation is denied due to invalid protocol service status.
403	OperationDenied.InvalidState	The operation is denied due to invalid file system state.
403	OperationDenied.NotSupported	The operation is denied due to not supported.
403	PermissionDenied.CLThroughputInvalid	Throughput of caching protocol service is invalid.
404	InvalidFileSystem.NotFound	The specified file system does not exist.
404	InvalidProtocolService.NotFound	The specified protocol service does not exist.
404	InvalidDescription.InvalidFormat	Description format is invalid.
404	OperationDenied.NoStock	The operation is denied due to no stock.

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

変更履歴

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