この操作は、指定されたリージョン内の転送ルールをクエリします。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
alb:ListRules |
get |
*LoadBalancer
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| NextToken |
string |
任意 |
次のページの検索結果を取得するために使用されるトークンです。有効な値:
|
FFmyTO70tTpLG6I3FmYAXGKPd**** |
| MaxResults |
integer |
任意 |
返すエントリの最大数。 有効な値: 1 から 100。 デフォルト値: 20。 説明
このパラメーターはオプションです。 |
20 |
| RuleIds |
array |
任意 |
転送ルールの ID。最大 20 個の転送ルール ID を指定できます。 |
|
|
string |
任意 |
転送ルール ID。 |
rule-sada****** |
|
| ListenerIds |
array |
任意 |
リスナーの ID。最大 20 個のリスナー ID を指定できます。 |
|
|
string |
任意 |
リスナー ID。 |
lsn-i35udpz3pxsmnf**** |
|
| LoadBalancerIds |
array |
任意 |
SLB インスタンスの ID。最大 20 個のインスタンス ID を指定できます。 |
|
|
string |
任意 |
SLB インスタンス ID。 |
alb-x30o38azsuj0sx**** |
|
| Direction |
string |
任意 |
転送ルールの方向。有効な値:
説明
Basic ALB インスタンスは Response タイプをサポートしていません。 |
Request |
| Tag |
array<object> |
任意 |
タグ。 |
|
|
object |
任意 |
タグ。 |
||
| Key |
string |
任意 |
タグキー。タグキーの長さは最大 128 文字です。`aliyun` または `acs:` で始めることはできず、`http://` または `https://` を含めることはできません。 |
env |
| Value |
string |
任意 |
タグ値。タグ値の長さは最大 128 文字です。`aliyun` または `acs:` で始めることはできず、`http://` または `https://` を含めることはできません。 |
product |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
転送ルール。 |
||
| MaxResults |
integer |
ページごとに返されるエントリの最大数。 |
50 |
| NextToken |
string |
次のページの検索結果を取得するために使用されるトークンです。有効な値:
|
FFmyTO70tTpLG6I3FmYAXGKPd**** |
| RequestId |
string |
リクエスト ID。 |
CEF72CEB-54B6-4AE8-B225-F876F****** |
| Rules |
array<object> |
転送ルールのリスト。 |
|
|
object |
転送ルール。 |
||
| ListenerId |
string |
転送ルールが属するリスナーの ID。 |
lsn-i35udpz3pxsmnf**** |
| LoadBalancerId |
string |
転送ルールが属する SLB インスタンスの ID。 |
alb-x30o38azsuj0sx**** |
| Priority |
integer |
ルールの優先度。値が小さいほど、優先度が高くなります。有効な値: 1 から 10000。 説明
各ルールの優先度は、リスナー内で一意である必要があります。 |
1 |
| RuleActions |
array<object> |
転送ルールのアクション。 |
|
|
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 ステータスコード。HTTP_2xx、HTTP_4xx、および HTTP_5xx のみがサポートされています。x は数字です。 |
HTTP_2xx |
| ForwardGroupConfig |
object |
転送グループの構成。 |
|
| ServerGroupTuples |
array<object> |
宛先サーバーグループ。 |
|
|
object |
宛先サーバーグループ。 |
||
| ServerGroupId |
string |
宛先サーバーグループの ID。 |
sgp-atstuj3rtoptyui**** |
| Weight |
integer |
重み。有効な値: 0 から 100。 |
2 |
| ServerGroupStickySession |
object |
サーバーグループのセッション維持設定。 |
|
| Enabled |
boolean |
サーバーグループ間のセッション維持を有効にするかどうかを指定します。このパラメーターは、`ServerGroupTuples` で複数のサーバーグループが指定されている場合に使用できます。 |
true |
| Timeout |
integer |
セッション維持のタイムアウト期間。このパラメーターは、`Enabled` が `true` に設定されている場合に使用できます。 |
100 |
| InsertHeaderConfig |
object |
挿入するヘッダーの構成。 |
|
| Key |
string |
挿入するヘッダーのキー。キーの長さは 1 ~ 40 文字である必要があります。文字、数字、アンダースコア (_)、およびハイフン (-) を含めることができます。 説明
キーを Cookie または Host に設定することはできません。 |
key |
| Value |
string |
挿入するヘッダーの値。
|
ClientSrcPort |
| ValueType |
string |
ヘッダー値のタイプ。有効な値:
|
SystemDefined |
| Order |
integer |
アクションの順序。有効な値: 1 から 50000。値が小さいほど、優先度が高くなります。このパラメーターの値は、同じルールの他のアクションの Order の値と同じにすることはできません。 |
1 |
| RedirectConfig |
object |
リダイレクトの構成。 |
|
| 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 |
リクエストがリダイレクトされる宛先のクエリ文字列。クエリ文字列は 1 ~ 128 文字の長さである必要があります。小文字と印刷可能文字を含めることができます。 |
quert |
| RemoveHeaderConfig |
object |
ヘッダーを削除するための構成。 |
|
| Key |
string |
削除するヘッダーのキー。キーの長さは 1 ~ 40 文字である必要があります。文字、数字、アンダースコア (_)、およびハイフン (-) を含めることができます。RemoveHeader のヘッダーキーは、削除されたヘッダーのキーと同じにすることはできません。
|
key |
| RewriteConfig |
object |
書き換えの構成。 |
|
| Host |
string |
リクエストがリダイレクトされる宛先ホスト。有効な値:
|
www.example.com |
| Path |
string |
リクエストがリダイレクトされる宛先パス。パスの長さは 1 ~ 128 文字である必要があります。スラッシュ (/) で始まる必要があります。文字、数字、アスタリスク (*)、疑問符 (?)、および次の特殊文字を含めることができます: |
/tsdf |
| Query |
string |
リクエストがリダイレクトされる宛先のクエリ文字列。クエリ文字列は 1 ~ 128 文字の長さである必要があります。小文字と印刷可能文字を含めることができます。 |
quedsa |
| TrafficMirrorConfig |
object |
トラフィックミラーリングの構成。 |
|
| TargetType |
string |
トラフィックミラーリングの宛先。値は `ForwardGroupMirror` にすることができます。 |
ForwardGroupMirror |
| MirrorGroupConfig |
object |
トラフィックがミラーリングされるサーバーグループ。 |
|
| ServerGroupTuples |
array<object> |
トラフィックがミラーリングされるサーバーグループ。 |
|
|
object |
|||
| ServerGroupId |
string |
サーバーグループ ID。 |
sgp-00mkgijak0w4qgz9**** |
| Weight |
integer |
重み。有効な値: 0 から 100。 |
2 |
| TrafficLimitConfig |
object |
速度制限の構成。 |
|
| QPS |
integer |
クエリ/秒 (QPS)。有効な値: 1 から 100000。 |
4 |
| PerIpQps |
integer |
単一 IP アドレスの QPS。有効な値: 1 から 100000。 説明
QPS と PerIpQps の両方を設定する場合、PerIpQps の値は QPS の値より小さくする必要があります。 |
80 |
| Type |
string |
アクションのタイプ。有効な値:
|
ForwardGroup |
| 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 |
| RuleConditions |
array<object> |
転送ルールの条件。 |
|
|
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 |
ヘッダーの値。値は 1 ~ 128 文字の長さである必要があります。ASCII 値が |
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 |
パス。パスの長さは 1 ~ 128 文字である必要があります。スラッシュ (/) で始まる必要があります。文字、数字、アスタリスク (*)、疑問符 (?)、および次の特殊文字を含めることができます: |
/test |
|
| QueryStringConfig |
object |
クエリ文字列の構成。 |
|
| Values |
array<object> |
クエリ文字列。 |
|
|
object |
クエリ文字列。 |
||
| Key |
string |
クエリ文字列のキー。キーの長さは 1 ~ 100 文字である必要があります。小文字、印刷可能文字、アスタリスク (*)、および疑問符 (?) を含めることができます。スペースまたは次の特殊文字を含めることはできません: |
test |
| Value |
string |
クエリ文字列の値。値は 1 ~ 128 文字の長さである必要があります。小文字、印刷可能文字、アスタリスク (*)、および疑問符 (?) を含めることができます。スペースまたは次の特殊文字を含めることはできません: |
test |
| SourceIpConfig |
object |
ソース IP アドレスの構成。 |
|
| Values |
array |
一致させるソース IP アドレス。 |
|
|
string |
1 つ以上の IP アドレスまたは CIDR ブロックを指定します。 各転送ルールに最大 5 つのソース IP アドレスを指定できます。 |
192.168.XX.XX/32 |
|
| ResponseStatusCodeConfig |
object |
レスポンスステータスコードの構成。 |
|
| Values |
array |
レスポンスステータスコード。 |
|
|
string |
レスポンスステータスコード。 |
200 |
|
| ResponseHeaderConfig |
object |
レスポンス HTTP ヘッダーの構成。 |
|
| Key |
string |
レスポンス HTTP ヘッダーのキー。キーの長さは 1 ~ 40 文字である必要があります。文字、数字、ハイフン (-)、およびアンダースコア (_) を含めることができます。キーを Cookie または Host に設定することはできません。 |
key |
| Values |
array |
レスポンス HTTP ヘッダーの値。 |
|
|
string |
レスポンス HTTP ヘッダーの値。値は 1 ~ 128 文字の長さである必要があります。 |
value |
|
| Type |
string |
転送ルールのタイプ。有効な値:
|
Host |
| RuleId |
string |
転送ルール ID。 |
rule-bpn0kn908w4nbw**** |
| RuleName |
string |
転送ルールの名前。名前は 2 ~ 128 文字の長さで、文字または漢字で始まり、文字、数字、ピリオド (.)、アンダースコア (_)、およびハイフン (-) を含めることができます。 |
rule-instance-test |
| RuleStatus |
string |
転送ルールのステータス。有効な値:
|
Available |
| Direction |
string |
転送ルールの方向。有効な値:
説明
Basic ALB インスタンスは Response タイプをサポートしていません。 |
Request |
| Tags |
array<object> |
タグ。 |
|
|
object |
タグ。 |
||
| Key |
string |
タグキー。タグキーの長さは最大 128 文字です。`aliyun` または `acs:` で始めることはできず、`http://` または `https://` を含めることはできません。 |
env |
| Value |
string |
タグ値。タグ値の長さは最大 128 文字です。`aliyun` または `acs:` で始めることはできず、`http://` または `https://` を含めることはできません。 |
product |
| TotalCount |
integer |
返されたエントリの総数。 |
1000 |
例
成功レスポンス
JSONJSON
{
"MaxResults": 50,
"NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
"RequestId": "CEF72CEB-54B6-4AE8-B225-F876F******",
"Rules": [
{
"ListenerId": "lsn-i35udpz3pxsmnf****",
"LoadBalancerId": "alb-x30o38azsuj0sx****",
"Priority": 1,
"RuleActions": [
{
"FixedResponseConfig": {
"Content": "dssacav",
"ContentType": "text/plain",
"HttpCode": "HTTP_2xx"
},
"ForwardGroupConfig": {
"ServerGroupTuples": [
{
"ServerGroupId": "sgp-atstuj3rtoptyui****",
"Weight": 2
}
],
"ServerGroupStickySession": {
"Enabled": true,
"Timeout": 100
}
},
"InsertHeaderConfig": {
"Key": "key",
"Value": "ClientSrcPort",
"ValueType": "SystemDefined"
},
"Order": 1,
"RedirectConfig": {
"Host": "www.example.com",
"HttpCode": "301",
"Path": "/test",
"Port": "10",
"Protocol": "HTTP",
"Query": "quert"
},
"RemoveHeaderConfig": {
"Key": "key"
},
"RewriteConfig": {
"Host": "www.example.com",
"Path": "/tsdf",
"Query": "quedsa"
},
"TrafficMirrorConfig": {
"TargetType": "ForwardGroupMirror",
"MirrorGroupConfig": {
"ServerGroupTuples": [
{
"ServerGroupId": "sgp-00mkgijak0w4qgz9****",
"Weight": 2
}
]
}
},
"TrafficLimitConfig": {
"QPS": 4,
"PerIpQps": 80
},
"Type": "ForwardGroup",
"CorsConfig": {
"AllowOrigin": [
"http://test.com"
],
"AllowMethods": [
"GET"
],
"AllowHeaders": [
"test_123"
],
"ExposeHeaders": [
"test_123"
],
"AllowCredentials": "on",
"MaxAge": 1000
}
}
],
"RuleConditions": [
{
"CookieConfig": {
"Values": [
{
"Key": "test",
"Value": "test"
}
]
},
"HeaderConfig": {
"Key": "Port",
"Values": [
"5006"
]
},
"HostConfig": {
"Values": [
"www.example.com"
]
},
"MethodConfig": {
"Values": [
"PUT"
]
},
"PathConfig": {
"Values": [
"/test"
]
},
"QueryStringConfig": {
"Values": [
{
"Key": "test",
"Value": "test"
}
]
},
"SourceIpConfig": {
"Values": [
"192.168.XX.XX/32"
]
},
"ResponseStatusCodeConfig": {
"Values": [
"200"
]
},
"ResponseHeaderConfig": {
"Key": "key",
"Values": [
"value"
]
},
"Type": "Host"
}
],
"RuleId": "rule-bpn0kn908w4nbw****",
"RuleName": "rule-instance-test",
"RuleStatus": "Available",
"Direction": "Request",
"Tags": [
{
"Key": "env",
"Value": "product"
}
]
}
],
"TotalCount": 1000
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 403 | Forbidden.LoadBalancer | Authentication is failed for %s. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。