UpdateForwardingRules API で GA 転送ルールを更新する - GA - Alibaba Cloud - Global Accelerator

転送ルールを更新します。

操作説明

UpdateForwardingRules は非同期操作です。リクエストが送信されると、システムはリクエスト ID を返しますが、転送ルールはまだ変更されていません。変更タスクはバックグラウンドで実行され続けます。 ListForwardingRules を呼び出して、転送ルールのステータスを照会できます。
- 転送ルールが configuring 状態の場合、転送ルールは変更中です。この状態では、クエリ操作のみを実行できます。
- 転送ルールが active 状態の場合、転送ルールはアクティブな状態です。
UpdateForwardingRules は、同じ Global Accelerator インスタンス内での転送ルールの同時変更をサポートしていません。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ga:UpdateForwardingRules

update

*Listener

acs:ga:{#regionId}:{#accountId}:listener/{#listenerId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	Global Accelerator インスタンスのリージョン ID。値を ap-southeast-1 に設定します。	cn-hangzhou
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。トークンには ASCII 文字のみを含めることができます。説明このパラメーターを指定しない場合、システムは自動的に RequestId の値を ClientToken の値として使用します。RequestId の値は、各 API 呼び出しごとに異なります。	02fb3da4****
AcceleratorId	string	必須	Global Accelerator インスタンスの ID。	ga-bp17frjjh0udz4q****
ListenerId	string	必須	リスナーの ID。	lsr-bp1s0vzbi5bxlx5****
ForwardingRules	array<object>	必須	転送ルールの構成。	test
	array<object>	任意	転送ルールの構成。
Priority	integer	必須	転送ルールの優先度。有効な値: 1 ～ 10000。値が小さいほど優先度が高くなります。	1000
RuleConditions	array<object>	必須	転送条件。
	array<object>	任意	転送条件。
RuleConditionType	string	必須	転送条件のタイプ。有効な値: Host: ドメイン名。 Path: パス。 RequestHeader: HTTP ヘッダー。 Query: クエリ文字列。 Method: HTTP リクエストメソッド。 Cookie: Cookie。 SourceIP: ソース IP アドレス。	Host
RuleConditionValue	string	任意	転送条件タイプに対応する値。 RuleConditionType の値に基づいて、異なる JSON 文字列値をセットします。 RuleConditionType が Host に設定されている場合、このパラメーターはドメイン名条件を指定します。1 つの転送ルールで作成できるドメイン名タイプの転送条件は 1 つのみですが、その条件内に複数のドメイン名を設定できます。複数のドメイン名の関係は OR です。ドメイン名の長さは 3 ～ 128 文字で、英数字、ハイフン (-)、ピリオド (.) を含めることができます。ワイルドカード文字としてアスタリスク () と疑問符 (?) がサポートされています。例: `["www.example.com", "www.aliyun.com"]`。 RuleConditionType* が Path に設定されている場合、このパラメーターはパス条件を指定します。1 つの転送ルールで複数のパスタイプの転送条件を作成でき、複数のパスタイプ条件の関係は OR です。1 つのパスタイプ条件内に複数のパスを設定でき、複数のパスの関係は OR です。パスの長さは 1 ～ 128 文字で、スラッシュ (/) で始まる必要があります。パスに含めることができるのは、英数字、ドル記号 ($)、ハイフン (-)、アンダースコア (_)、ピリオド (.)、プラス記号 (+)、スラッシュ (/)、アンパサンド (&)、チルダ (~)、アットマーク (@)、コロン (:)、アポストロフィ (') のみです。ワイルドカード文字としてアスタリスク () と疑問符 (?) がサポートされています。例: `["/a", "/b/"]`。 RuleConditionType* が RequestHeader に設定されている場合、このパラメーターは HTTP ヘッダー条件を指定します。これはキーと値で構成されます。同じ転送条件内でヘッダーフィールドの値を重複させることはできません。例: `[{"header1":["value1","value2"]}]`。キー: HTTP ヘッダーのキーの長さは 1 ～ 40 文字で、英数字、ハイフン (-)、アンダースコア (_) を含めることができます。値: HTTP ヘッダーの値の長さは 1 ～ 128 文字で、`ch >= 32 && ch < 127` の範囲の印刷可能な ASCII 文字を含めることができます。値の先頭または末尾にスペースを使用することはできません。 RuleConditionType が Query に設定されている場合、このパラメーターはクエリ文字列条件を指定します。これはキーと値で構成されます。例: `[{"query1":["value1"]}, {"query2":["value2"]}]`。キー: キーの長さは 1 ～ 100 文字で、`ch >= 32 && ch < 127` の範囲の印刷可能な ASCII 文字を含めることができます。アルファベットは小文字である必要があります。スペースおよび次の文字はサポートされていません: `[]{}<>\;/?:@&=+,$%\|"^~`。値: 値の長さは 1 ～ 128 文字で、`ch >= 32 && ch < 127` の範囲の印刷可能な ASCII 文字を含めることができます。アルファベットは小文字である必要があります。スペースおよび次の文字はサポートされていません: `[]{}<>\;/?:@&=+,$%\|"^~`。 RuleConditionType が Method に設定されている場合、このパラメーターはリクエストメソッド条件を指定します。有効な値: HEAD、GET、POST、OPTIONS、PUT、PATCH、DELETE。例: `["GET", "OPTIONS", "POST"]`。 RuleConditionType が Cookie に設定されている場合、このパラメーターは Cookie 条件を指定します。これはキーと値で構成されます。例: `[{"cookie1":["value1"]}, {"cookie2":["value2"]}]`。キー: キーの長さは 1 ～ 100 文字で、`ch >= 32 && ch < 127` の範囲の印刷可能な ASCII 文字を含めることができます。アルファベットは小文字である必要があります。スペースおよび次の文字はサポートされていません: `#[]{}\\|<>&`。値: 値の長さは 1 ～ 128 文字で、`ch >= 32 && ch < 127` の範囲の印刷可能な ASCII 文字を含めることができます。アルファベットは小文字である必要があります。スペースおよび次の文字はサポートされていません: `#[]{}\\|<>&`。 RuleConditionType が SourceIP に設定されている場合、このパラメーターはソース IP アドレス条件を指定します。1.1.XX.XX/32 などの IP アドレスや 2.2.XX.XX/24 などの CIDR ブロックがサポートされています。1 つの転送ルールで作成できるソース IP 条件は 1 つのみですが、その条件内に複数のソース IP アドレスを設定できます。複数の IP アドレスの関係は OR です。例: `["1.1.XX.XX/32", "2.2.XX.XX/24"]`。	["www.example.com", "www.aliyun.com"]
PathConfig	object	任意	パスの構成。説明このパラメーターは推奨されません。転送条件を設定するには、RuleConditionType と RuleConditionValue を使用してください。
Values	array	任意	パス構成です。説明このパラメーターは非推奨です。RuleConditionType および RuleConditionValue パラメーターを使用することを推奨します。
	string	任意	パス構成です。パスは 1～128 文字で、スラッシュ (/) で始まり、英数字および以下の特殊文字のみを含めることができます：`$`、`-`、`_`、`.`、`+`、`/`、`&`、`~`、`@`、`:`、`'`。ワイルドカードとしてアスタリスク () および疑問符 (?) を使用できます。説明このパラメーターは非推奨です。RuleConditionType* および RuleConditionValue パラメーターを使用することを推奨します。	/test
HostConfig	object	任意	ドメイン名の構成。説明このパラメーターは推奨されません。転送条件を設定するには、RuleConditionType と RuleConditionValue を使用してください。
Values	array	任意	ドメイン構成です。説明このパラメーターは非推奨です。RuleConditionType および RuleConditionValue パラメーターを使用することを推奨します。
	string	任意	ドメイン構成です。ドメインは 3～128 文字で、英数字、ハイフン (-)、ピリオド (.) を含めることができます。ワイルドカードとしてアスタリスク (*) および疑問符 (?) を使用できます。	example.com
RuleActions	array<object>	必須	転送操作。
	array<object>	必須	転送操作。
Order	integer	必須	転送の優先度。説明このパラメーターは使用されません。設定する必要はありません。	20
RuleActionType	string	必須	転送操作のタイプ。有効な値: ForwardGroup: リクエストを転送します。 Redirect: リクエストをリダイレクトします。 FixResponse: 固定応答を返します。 Rewrite: リクエストを再書き込みします。 AddHeader: ヘッダーフィールドを追加します。 RemoveHeader: ヘッダーフィールドを削除します。 Drop: リクエストをドロップします。	ForwardGroup
RuleActionValue	string	任意	転送操作タイプに対応する値。 RuleActionType の値に基づいて、異なる JSON 文字列値を指定します。 1 つの転送ルールには、ForwardGroup、Redirect、または FixResponse 操作を最大 1 つ含めることができます。Rewrite、AddHeader、および RemoveHeader 操作は、ForwardGroup 操作より前に順序付ける必要があります。 RuleActionType が ForwardGroup に設定されている場合、このパラメーターは仮想エンドポイントグループ情報を指定します。サポートされる仮想エンドポイントグループは 1 つのみです。例: `{"type":"endpointgroup", "value":"epg-bp1enpdcrqhl78g6r**"}`。ここで: `type`: 値を `endpointgroup` にセットします。 `value`: 送信先の仮想エンドポイントグループの ID。 RuleActionType が Redirect に設定されている場合、このパラメーターはリダイレクト構成を指定します。Redirect** 操作では、`protocol`、`domain`、`port`、`path`、`query` のすべてを空にしたり、デフォルト値に設定したりすることはできません。例: `{"protocol":"HTTP", "domain":"www.example.com", "port":"80", "path":"/a","query":"value1", "code":"301" }`。ここで: `protocol`: リダイレクトプロトコル。有効な値: `HTTP`、`HTTPS`。デフォルト値: `HTTP`。 `domain`: リダイレクト先のドメイン名。このパラメーターが空の場合、元のドメイン名が保持されます。ドメイン名の長さは 3 ～ 128 文字で、小文字の英数字と次の特殊文字のみを含めることができます: `.-?=~_-+/^!$&()[]`。 `port`: リダイレクト先のポート。このパラメーターが空の場合、デフォルトのポートが使用されます。デフォルトのポートは、`HTTP リスナー`の場合は `80`、`HTTPS リスナー`の場合は `443` です。有効な値: `1` ～ `63335`。 `path`: リダイレクト先のパス。このパラメーターが空の場合、元のパスが保持されます。パスの長さは 1 ～ 128 文字である必要があります。正規表現パスはチルダ (~) で始まり、大文字・小文字の英数字と次の特殊文字を含めることができます: `.-_/=?~^$:()[]+`。正規表現以外のパスはスラッシュ (/) で始まり、大文字・小文字の英数字と次の特殊文字を含めることができます: `.-_/=?:`。 `query`: リダイレクト先のクエリパラメーター。このパラメーターが空の場合、元のクエリ文字列が保持されます。クエリ文字列の長さは 1 ～ 128 文字で、`ch >= 32 && ch < 127` の範囲の印刷可能な ASCII 文字を含めることができます。アルファベットは小文字である必要があります。スペースおよび次の特殊文字はサポートされていません: `[]{}<>\#&`。 `code`: リダイレクトタイプ。有効な値: `301`、`302`、`303`、`307`、`308`。 RuleActionType が FixResponse に設定されている場合、このパラメーターは固定応答の構成を指定します。例: `{"code":"200", "type":"text/plain", "content":"dssacav" }`。ここで: `code`: 応答の状態コード。`2xx`、`4xx`、`5xx` のフォーマットの数値文字列のみがサポートされています。`x` は任意の数字です。 `type`: レスポンスボディのコンテンツタイプ。有効な値: text/plain、text/css、text/html、application/javascript、application/json。 `content`: レスポンスボディ。レスポンスボディの長さは 1000 文字を超えることができず、中国語文字はサポートされていません。 RuleActionType が AddHeader に設定されている場合、このパラメーターは挿入する HTTP ヘッダーフィールドを指定します。転送ルールに AddHeader 操作が含まれている場合は、ForwardGroup 操作も設定する必要があります。例: `[{"name":"header1","type":"user-defined", "value":"value"}]`。ここで: `name`: HTTP ヘッダーフィールドの名前。名前の長さは 1 ～ 40 文字で、大文字・小文字の英数字、ハイフン (-)、アンダースコア (_) を含めることができます。AddHeader の HTTP ヘッダーフィールド名を重複させたり、RemoveHeader の HTTP ヘッダーフィールド名と同じにしたりすることはできません。 `type`: HTTP ヘッダーフィールドのコンテンツタイプ。有効な値: `user-defined`、`ref`、`system-defined`。 `value`: HTTP ヘッダーフィールドの内容。内容を空にすることはできません。`type` が `user-defined` に設定されている場合、値の長さは 1 ～ 128 文字で、`ch >= 32 && ch < 127` の範囲の印刷可能な ASCII 文字 (大文字・小文字の英数字、ハイフン (-)、アンダースコア (_) を含む) を含めることができます。値の先頭または末尾にスペースを使用することはできません。`type` が `ref` に設定されている場合、値の長さは 1 ～ 128 文字で、大文字・小文字の英数字、ハイフン (-)、アンダースコア (_) を含めることができます。値の先頭または末尾にスペースを使用することはできません。`type` が `system-defined` に設定されている場合、`ClientSrcIp` のみがサポートされています。 RuleActionType が RemoveHeader に設定されている場合、このパラメーターは削除する HTTP ヘッダーフィールドを指定します。転送ルールに RemoveHeader 操作が含まれている場合は、ForwardGroup 操作も設定する必要があります。名前の長さは 1 ～ 40 文字で、大文字・小文字の英数字、ハイフン (-)、アンダースコア (_) を含めることができます。例: `["header1"]`。 RuleActionType が Rewrite に設定されている場合、このパラメーターは再書き込み構成を指定します。転送ルールに Rewrite 操作が含まれている場合は、ForwardGroup 操作も設定する必要があります。例: `{"domain":"value1", "path":"value2", "query":"value3"}`。ここで: `domain`: 再書き込み先のドメイン名。このパラメーターが空の場合、元のドメイン名が保持されます。ドメイン名の長さは 3 ～ 128 文字で、小文字の英数字と次の特殊文字のみを含めることができます: `.-?=~_-+/^!$&()[]`。 `path`: 再書き込み先のパス。このパラメーターが空の場合、元のパスが保持されます。パスの長さは 1 ～ 128 文字である必要があります。正規表現パスはチルダ (~) で始まり、大文字・小文字の英数字と次の特殊文字を含めることができます: `.-_/=?~^$:()[]+`。正規表現以外のパスはスラッシュ (/) で始まり、大文字・小文字の英数字と次の特殊文字を含めることができます: `.-_/=?:`。 `query`: 再書き込み先のクエリパラメーター。このパラメーターが空の場合、元のクエリ文字列が保持されます。クエリ文字列の長さは 1 ～ 128 文字で、`ch >= 32 && ch < 127` の範囲の印刷可能な ASCII 文字を含めることができます。アルファベットは小文字である必要があります。スペースおよび次の特殊文字はサポートされていません: `[]{}<>\#&`。 RuleActionType が Drop に設定されている場合、このパラメーターを指定する必要はありません。	[{"type":"endpointgroup", "value":"epg-bp1enpdcrqhl78g6r****"}]
ForwardGroupConfig	object	任意	転送操作の構成。説明このパラメーターは推奨されません。転送操作を設定するには、RuleActionType と RuleActionValue を使用してください。
ServerGroupTuples	array<object>	必須	エンドポイントグループ構成です。説明このパラメーターは非推奨です。RuleActionType および RuleActionValue パラメーターを使用することを推奨します。
	object	必須	エンドポイントグループ構成です。説明このパラメーターは非推奨です。RuleActionType および RuleActionValue パラメーターを使用することを推奨します。
EndpointGroupId	string	必須	エンドポイントグループの ID です。説明このパラメーターは非推奨です。RuleActionType および RuleActionValue パラメーターを使用することを推奨します。	epg-bp1ieei9664r5nv****
ForwardingRuleId	string	必須	転送ルールの ID。	frule-bp1dii16gu9qdvb34****
ForwardingRuleName	string	任意	転送ルールのポリシー名。ポリシー名の長さは 2 ～ 128 文字で、英数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を含めることができます。ポリシー名の先頭は英字または漢字である必要があります。	test
RuleDirection	string	任意	ルールの効果が及ぶ方向。このパラメーターを設定する必要はありません。デフォルト値は request で、ルールがリクエストに対して効果があることを示します。	request

レスポンスフィールド

フィールド	型	説明	例
	object	応答パラメーター。
ForwardingRules	array<object>	転送ルールの情報。
	object	転送ルールの情報。
ForwardingRuleId	string	転送ルールの ID。	frule-bp1dii16gu9qdvb34****
RequestId	string	リクエスト ID。	64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF

例

成功レスポンス

JSONJSON

{
  "ForwardingRules": [
    {
      "ForwardingRuleId": "frule-bp1dii16gu9qdvb34****"
    }
  ],
  "RequestId": "64ADAB1E-0B7F-4FD8-A404-3BECC0E9CCFF"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	NotExist.Listener	The listener does not exist.	The listener does not exist.
400	NotActive.Listener	The state of the listener is not active.	The state of the listener is not active.
400	NotExist.Accelerator	The accelerated instance does not exist.	The accelerated instance does not exist.
400	StateError.Accelerator	The state of the accelerated instance is invalid.
400	NotExist.BasicBandwidthPackage	You must specify the basic bandwidth package.	You must specify the basic bandwidth package.
400	QuotaExceeded.EndPoint	The maximum number of endpoints is exceeded.	The maximum number of endpoints is exceeded.
400	Exist.EndpointGroup	The endpoint group already exists.
400	NoPermission.VpcEndpoint	You are not authorized to perform the operation.
400	SystemBusy	System busy, please try again later.
400	RepeatPathAndHost.ForwardingRule	The path and host %s are duplicated.
400	QuotaExceeded.RuleConditionConfig	The number of paths and hosts exceeds the limit.
400	NotExist.BusinessRegion	The business region does not exist.	The business region does not exist.
400	NotExist.ForwardingRule	The forwarding rule %s does not exist.

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

変更履歴

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