転送ルールの属性(条件、操作、名前など)を更新します。
操作説明
UpdateRuleAttribute は非同期操作です。リクエスト
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
alb:UpdateRuleAttribute |
update |
*LoadBalancer
*ServerGroup
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RuleId |
string |
必須 |
転送ルールの ID。 |
rule-4dp5i6ea**** |
| ClientToken |
string |
任意 |
リクエストのべき等性を確保するために使用されるクライアントトークン。 クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。トークンには ASCII 文字のみを含めることができます。 説明
このパラメーターを指定しない場合、システムは自動的に RequestId の値を ClientToken の値として使用します。各 API 呼び出しの RequestId の値は異なります。 |
5A2CFF0E-5718-45B5-9D4D-70B3FF3898 |
| DryRun |
boolean |
任意 |
実際のリクエストを実行せずに、ドライランのみを実行するかどうかを指定します。有効な値:
|
false |
| RuleConditions |
array<object> |
任意 |
転送ルールの条件。 |
|
|
array<object> |
任意 |
転送ルールの条件。 |
||
| CookieConfig |
object |
任意 |
Cookie の構成。 |
|
| Values |
array<object> |
任意 |
Cookie の構成。 |
|
|
object |
任意 |
Cookie の構成。 |
||
| Key |
string |
任意 |
Cookie のキー。 キーの長さは 1~100 文字で、小文字、表示可能な文字、アスタリスク (*)、疑問符 (?) を使用できます。 キーにスペースまたは次の特殊文字を含めることはできません: |
test |
| Value |
string |
任意 |
Cookie の値。 値の長さは 1~128 文字で、小文字、表示可能な文字、アスタリスク (*)、疑問符 (?) を使用できます。 値にスペースまたは次の特殊文字を含めることはできません: |
test |
| HeaderConfig |
object |
任意 |
ヘッダーの構成。 |
|
| Key |
string |
任意 |
ヘッダーのキー。キーの長さは 1~40 文字で、英字、数字、ハイフン (-)、アンダースコア (_) を含めることができます。Cookie および Host はサポートされていません。 |
Port |
| Values |
array |
任意 |
ヘッダーの値。 |
|
|
string |
任意 |
ヘッダーの値。同じ転送ルール条件内のヘッダー値は重複できません。命名規則:
|
5006 |
|
| HostConfig |
object |
任意 |
ホストの構成。 |
|
| Values |
array |
任意 |
ホスト名。 |
|
|
string |
任意 |
ホスト名。命名規則:
|
www.example.com |
|
| MethodConfig |
object |
任意 |
リクエストメソッドの構成。 |
|
| Values |
array |
任意 |
リクエストメソッド。 |
|
|
string |
任意 |
リクエストメソッド。 有効な値: HEAD、GET、POST、OPTIONS、PUT、PATCH、DELETE。 |
PUT |
|
| PathConfig |
object |
任意 |
転送用のパス構成。 |
|
| Values |
array |
任意 |
転送パス。 |
|
|
string |
任意 |
転送パス。命名規則:
|
/test |
|
| QueryStringConfig |
object |
任意 |
クエリ文字列の構成。 |
|
| Values |
array<object> |
任意 |
クエリ文字列。最大 20 個のクエリ文字列を追加できます。 |
|
|
object |
任意 |
クエリ文字列の構造。 |
||
| Key |
string |
任意 |
クエリ文字列のキー。 キーの長さは 1~100 文字で、小文字、表示可能な文字、アスタリスク (*)、疑問符 (?) を使用できます。 キーにスペースまたは次の特殊文字を含めることはできません: |
test |
| Value |
string |
任意 |
クエリ文字列の値。 値の長さは 1~128 文字で、小文字、表示可能な文字、アスタリスク (*)、疑問符 (?) を使用できます。 値にスペースまたは次の特殊文字を含めることはできません: |
test |
| Type |
string |
任意 |
転送ルールのタイプ。最大 7 タイプの転送ルールを追加できます。有効な値:
|
Host |
| ResponseStatusCodeConfig |
object |
任意 |
レスポンス状態コードの構成。 |
|
| Values |
array |
任意 |
レスポンス状態コードのリスト。 |
|
|
string |
任意 |
レスポンス状態コード。 |
301 |
|
| ResponseHeaderConfig |
object |
任意 |
レスポンスヘッダー条件の構成。 |
|
| Key |
string |
任意 |
ヘッダーのキー。
|
test |
| Values |
array |
任意 |
ヘッダーの値。 |
|
|
string |
任意 |
ヘッダーの値。
|
50006 |
|
| SourceIpConfig |
object |
任意 |
ソース IP サービストラフィックマッチングの構成。最大 5 つのソース IP サービストラフィックマッチング条件を追加できます。 |
|
| Values |
array |
任意 |
1 つ以上の IP アドレスまたは CIDR ブロック。 |
|
|
string |
任意 |
1 つ以上の IP アドレスまたは CIDR ブロック。 |
192.168.0.0/32 |
|
| RuleActions |
array<object> |
任意 |
転送ルールの操作。 |
|
|
array<object> |
任意 |
転送ルールの操作。 |
||
| FixedResponseConfig |
object |
任意 |
固定応答の構成。 |
|
| Content |
string |
任意 |
返す固定コンテンツ。コンテンツのサイズは最大 1 KB で、ASCII 文字のみを含めることができます。 |
dssacav |
| ContentType |
string |
任意 |
返す固定コンテンツのフォーマット。 有効な値: text/plain、text/css、text/html、application/javascript、application/json。 |
text/plain |
| HttpCode |
string |
任意 |
返す HTTP 応答コード。2xx、4xx、5xx フォーマットの数字文字列のみがサポートされています。ここで x は任意の数字です。 |
200 |
| ForwardGroupConfig |
object |
任意 |
転送グループの構成。 |
|
| ServerGroupTuples |
array<object> |
任意 |
リクエストの転送先となる送信先サーバーグループ。 |
|
|
object |
任意 |
送信先サーバーグループの構造。 |
||
| ServerGroupId |
string |
任意 |
宛先サーバーグループの ID。 |
sg--atstuj3rtoptyui**** |
| Weight |
integer |
任意 |
サーバーグループの重み。 値が大きいほど、重みが高くなります。 これは、サーバーグループがより多くのリクエストを受信することを意味します。 有効値:0~100。
|
30 |
| ServerGroupStickySession |
object |
任意 |
サーバーグループ間のセッション維持の構成。 |
|
| Enabled |
boolean |
任意 |
セッション維持を有効にするかどうかを指定します。 有効値:
|
false |
| Timeout |
integer |
任意 |
タイムアウト期間 (秒単位)。 有効値:1~86400。 |
2 |
| InsertHeaderConfig |
object |
任意 |
ヘッダー挿入の構成。 |
|
| CoverEnabled |
boolean |
任意 |
リクエスト内の値を上書きするかどうかを指定します。有効な値:
|
false |
| Key |
string |
任意 |
挿入するヘッダーの名前。名前の長さは 1~40 文字で、大文字・小文字の a~z、数字、アンダースコア (_)、ハイフン (-) を含めることができます。InsertHeaderConfig で指定するヘッダー名は一意である必要があります。 説明
ヘッダー名には、以下のフィールドを設定できません (大文字・小文字は区別されません): |
key |
| Value |
string |
任意 |
挿入するヘッダーのコンテンツ。
|
UserDefined |
| ValueType |
string |
任意 |
ヘッダー値のコンテンツタイプ。有効な値:
|
UserDefined |
| Order |
integer |
任意 |
転送ルールにおける操作の優先度。有効な値: 1~50000。操作は優先度の昇順に実行されます。この値を空にしたり、重複させたりすることはできません。最大 20 個の操作優先度を指定できます。 |
1 |
| RedirectConfig |
object |
任意 |
リダイレクトの構成。最大 20 個のリダイレクトを追加できます。 |
|
| Host |
string |
任意 |
リダイレクト先のホスト。有効な値:
|
www.example.com |
| HttpCode |
string |
任意 |
リダイレクトタイプ。有効な値: 301、302、303、307、308。 |
301 |
| Path |
string |
任意 |
リダイレクト先のパス。有効な値:
|
/test |
| Port |
string |
任意 |
リダイレクト先のポート。有効な値:
|
10 |
| Protocol |
string |
任意 |
リダイレクト先のプロトコル。有効な値:
説明
HTTPS リスナーは HTTPS へのリダイレクトのみをサポートします。 |
HTTP |
| Query |
string |
任意 |
リダイレクト先のクエリ文字列。有効な値:
|
quert |
| RewriteConfig |
object |
任意 |
再書き込みの構成。 |
|
| Host |
string |
任意 |
内部リダイレクト用の送信先ホストアドレス。有効な値:
|
www.example.com |
| Path |
string |
任意 |
リダイレクト先のパス。有効な値:
|
/tsdf |
| Query |
string |
任意 |
内部リダイレクト用のクエリ文字列。有効な値:
|
quedsa |
| Type |
string |
任意 |
操作タイプ。最大 11 タイプの操作を追加できます。有効な値:
説明
転送ルールには、ForwardGroup、Redirect、または FixedResponse のいずれかの操作を含める必要があります。この操作が他の操作タイプと共存する場合、最後に実行する操作である必要があります。 |
ForwardGroup |
| TrafficLimitConfig |
object |
任意 |
トラフィック速度制限の構成。 |
|
| QPS |
integer |
任意 |
1 秒あたりのクエリ数 (QPS)。有効な値: 1~1000000。 |
100 |
| PerIpQps |
integer |
任意 |
IP アドレスごとの QPS。有効な値: 1~1000000。 説明
QPS と PerIpQps の両方が設定されている場合、PerIpQps の値は QPS の値より小さくする必要があります。 |
80 |
| TrafficMirrorConfig |
object |
任意 |
トラフィックミラーリングの構成。 |
|
| TargetType |
string |
任意 |
ミラーターゲットのタイプ。有効な値:
|
ForwardGroupMirror |
| MirrorGroupConfig |
object |
任意 |
サーバーグループへのトラフィックミラーリングの構成。 |
|
| ServerGroupTuples |
array<object> |
任意 |
トラフィックがミラーリングされるサーバーグループ。 |
|
|
object |
任意 |
トラフィックがミラーリングされるサーバーグループ。 |
||
| ServerGroupId |
string |
任意 |
サーバーグループの ID。 |
srg-00mkgijak0w4qgz9**** |
| RemoveHeaderConfig |
object |
任意 |
ヘッダー削除の構成。 |
|
| Key |
string |
任意 |
削除するヘッダーの名前。名前の長さは 1~40 文字で、大文字・小文字の a~z、数字、アンダースコア (_)、ハイフン (-) を含めることができます。RemoveHeader 内でヘッダー名を重複させることはできません。
|
test |
| CorsConfig |
object |
任意 |
リソース共有 (CORS) の構成。 |
|
| AllowOrigin |
array |
任意 |
許可されたオリジンのリスト。単一の要素
|
|
|
string |
任意 |
許可されたオリジン。 |
http://test.com |
|
| AllowMethods |
array |
任意 |
クロスオリジンアクセス用に許可された HTTP メソッド。 |
|
|
string |
任意 |
クロスオリジンアクセス用に許可された HTTP メソッド。有効な値:
|
GET |
|
| AllowHeaders |
array |
任意 |
クロスオリジンアクセス用に許可されたヘッダーのリスト。 |
|
|
string |
任意 |
クロスオリジンアクセス用に許可されたヘッダー。これを |
test_123 |
|
| ExposeHeaders |
array |
任意 |
公開できるヘッダーのリスト。 |
|
|
string |
任意 |
公開できるヘッダー。これを |
test_123 |
|
| AllowCredentials |
string |
任意 |
認証情報を許可するかどうかを指定します。有効な値:
|
on |
| MaxAge |
integer |
任意 |
ブラウザでのプリフライトリクエストの最大キャッシュ時間の最大値。単位: 秒。 有効な値: -1~172800。 |
1000 |
| RuleName |
string |
任意 |
転送ルールの名前。名前の長さは 2~128 文字で、英字、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-)、スペースを含めることができます。名前は英字、漢字、または数字で始まる必要があります。 |
rule-instance-test |
| Priority |
integer |
任意 |
ルールの優先度。有効な値: 1~10000。値が小さいほど優先度が高くなります。 説明
同じリスナー内のルール優先度は一意である必要があります。 |
10 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
転送ルール属性更新の応答。 |
||
| JobId |
string |
非同期タスクの ID。 |
72dcd26b-f12d-4c27-b3af-18f6aed5**** |
| RequestId |
string |
リクエストの ID。 |
365F5378-41F6-4AE4-92F8-7FF34B540710 |
例
成功レスポンス
JSONJSON
{
"JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****",
"RequestId": "365F5378-41F6-4AE4-92F8-7FF34B540710"
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | IncorrectStatus.Rule | The status of %s [%s] is incorrect. | |
| 400 | OperationDenied.IpGroupCanNotUsedForMirrorAction | The operation is not allowed because of %s. | |
| 400 | OperationDenied.SameGroupForForwardAndMirrorAction | The operation is not allowed because of %s. | |
| 400 | OperationDenied.GRPCServerGroup | The operation is not allowed because of %s. | |
| 400 | Conflict.Priority | There is already %s having the same configuration with %s. | |
| 400 | ResourceQuotaExceeded.ServerGroupAttachedNum | The quota of %s is exceeded for resource %s, usage %s/%s. | |
| 400 | ResourceQuotaExceeded.LoadBalancerServersNum | The quota of %s is exceeded for resource %s, usage %s/%s. | |
| 400 | ResourceQuotaExceeded.ServerAddedNum | The quota of %s is exceeded for resource %s, usage %s/%s. | |
| 400 | QuotaExceeded.RuleWildcardsNum | The quota of %s is exceeded, usage %s/%s. | |
| 400 | QuotaExceeded.RuleMatchEvaluationsNum | The quota of %s is exceeded, usage %s/%s. | |
| 400 | QuotaExceeded.RuleActionsNum | The quota of %s is exceeded, usage %s/%s. | |
| 400 | Mismatch.Protocol | The %s is mismatched for %s and %s. | |
| 400 | Mismatch.VpcId | The %s is mismatched for %s and %s. | |
| 400 | OperationDenied.RewriteMissingForwardGroup | The operation is not allowed because of RewriteMissingForwardGroup. | |
| 400 | ResourceInConfiguring.Listener | The specified listener is being configured, please try again later. | |
| 400 | OperationDenied.ProtocolMustSameForForwardGroupAction | The operation is not allowed because of ProtocolMustSameForForwardGroupAction. | |
| 403 | Forbidden.ServerGroup | Authentication has failed for ServerGroup. | |
| 403 | Forbidden.LoadBalancer | Authentication is failed for %s. | |
| 404 | ResourceNotFound.Rule | The specified resource %s is not found. | |
| 404 | ResourceNotFound.ServerGroup | The specified resource %s is not found. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。