UpdateEnterpriseSnapshotPolicy - - Alibaba Cloud ドキュメントセンター

エンタープライズレベルのスナップショットポリシーの構成を変更します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ebs:UpdateEnterpriseSnapshotPolicy

update

*EnterpriseSnapshotPolicy

acs:ebs:{#regionId}:{#accountId}:enterprisesnapshotpolicy/{#EnterpriseSnapshotPolicyId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	リージョン ID。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。	cn-hangzhou
PolicyId	string	必須	スナップショットポリシーの ID。	esp-xxx
Name	string	任意	変更するポリシーの ID。	xxx
State	string	任意	スナップショットポリシーのステータス。有効な値: ENABLED DISABLED 列挙値: DISABLED : DISABLED。 ENABLED : ENABLED。	ENABLED
Desc	string	任意	スナップショットポリシーの説明。	xxx
Schedule	object	任意	スケジュールルール。
CronExpression	string	必須	ポリシーの実行サイクルと時間。cron 式を使用します。たとえば、`0 0 4 1/1 * ?` は、毎月 1 日から毎日 04:00 にスナップショット操作を実行することを指定します。	0 0 /24 * *
RetainRule	object	任意	保持ルール。
Number	integer	任意	保持するスナップショットの数。有効な値: 1～256。	10
TimeInterval	integer	任意	保持ルールの時間間隔。単位は TimeUnit パラメーターで指定されます。値は 1 より大きい必要があります。	14
TimeUnit	string	任意	保持時間の単位。有効な値: DAYS WEEKS 列挙値: WEEKS : WEEKS。 DAYS : DAYS。	DAYS
SpecialRetainRules	object	任意	特別保持ルール。
Enabled	boolean	任意	特別保持を有効にするかどうかを指定します。有効な値: true false 列挙値: true : true。 false : false。	false
Rules	array<object>	任意	特別保持ルールのリスト。複数のルールがサポートされています。
	object	任意	特別保持ルール。
SpecialPeriodUnit	string	任意	特別保持スナップショットの期間単位。たとえば、このパラメーターを WEEKS にセットすると、毎週の最初のスナップショットに特別保持が適用されます。保持持続時間は TimeUnit および TimeInterval パラメーターによって決定されます。有効な値: WEEKS MONTHS YEARS 列挙値: MONTHS : MONTHS。 YEARS : YEARS。 WEEKS : WEEKS。	WEEKS
TimeInterval	integer	任意	保持ルールの時間間隔。単位は TimeUnit パラメーターで指定されます。値は 1 より大きい必要があります。	30
TimeUnit	string	任意	特別スナップショットの保持時間の単位。有効な値: DAYS WEEKS 列挙値: WEEKS : WEEKS。 DAYS : DAYS。	DAYS
CrossRegionCopyInfo	object	任意	クロスリージョンコピーのターゲットリージョン情報。フォーマット。
Enabled	boolean	任意	クロスリージョンレプリケーションを有効にするかどうかを指定します。有効な値: true false 列挙値: true : true。 false : false。	false
Regions	array<object>	任意	ターゲットリージョンの情報。フォーマット。
	object	任意	コピー先のターゲットリージョン情報。フォーマット。
RegionId	string	任意	スナップショットレプリケーションのターゲットリージョン ID。フォーマット。 DescribeDiskReplicaPairs を呼び出して、既存の非同期レプリケーション関係のリージョン情報をクエリできます。	cn-hangzhou
RetainDays	integer	任意	ターゲットリージョンでスナップショットを保持する日数。値は 1 より大きい必要があります。	7
ClientToken	string	任意	リクエストのべき等性を確保します。クライアント側でパラメーター値を生成し、異なるリクエスト間で値が一意になるようにしてください。ClientToken の値は ASCII 文字のみをサポートし、長さは 64 文字を超えることはできません。フォーマット。詳細については、「べき等性を確保する方法」を参照してください。	123e4567-e89b-12d3-a456-42665544****
StorageRule	object	任意	高度なスナップショット特徴。
EnableImmediateAccess	boolean	任意	スナップショットの即時アクセスを有効にするかどうかを指定します。有効な値: true false 列挙値: true : true。 false : false。	false

レスポンスフィールド

フィールド	型	説明	例
	object	応答。
RequestId	string	リクエストの ID。	FED145A8-7D5F-5C60-B054-4EB2899A5996

例

成功レスポンス

JSONJSON

{
  "RequestId": "FED145A8-7D5F-5C60-B054-4EB2899A5996"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidParameter	The parameter %s is invalid.
400	InvalidParameter.Conflict	The specified parameter %s and %s are not blank at the same time.
400	InvalidParameter.Format	Specified parameter format is not valid.	日文说明
400	MissingParameter	The input parameter %s that is mandatory for processing this request is not supplied.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.
403	Forbidden	User is not authorized to operate.
403	Forbidden.Action	User is not authorized to operate this action.
403	InvalidAccountStatus.NotEnoughBalance	Your account does not have enough balance.
403	LastTokenProcessing	The last token request is processing.
403	NoPermission.SLR	The RAM user does not have the permission to create service linked role: AliyunServiceLinkedRoleForEBS.
403	OperationDenied	The operation is not allowed.
404	InvalidApi.NotFound	Specified api is not found, please check your url and method.
404	NoSuchResource	The specified resource does not exist.
504	RequestTimeout	The request is timeout, please try again later.

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

変更履歴

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