調用ListForwardingRules接口獲取轉發規則列表。
接口說明
說明
調用該接口只能查看自定義轉發策略信息,無法查看默認轉發策略信息。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
ga:ListForwardingRules | list |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 全球加速實例所屬的地域 ID,僅取值:cn-hangzhou。 | cn-hangzhou |
ClientToken | string | 否 | 客戶端 Token,用于保證請求的冪等性。 從您的客戶端生成一個參數值,確保不同請求間該參數值唯一。ClientToken 只支持 ASCII 字符。 說明
若您未指定,則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。
| 02fb3da4**** |
ListenerId | string | 是 | 監聽實例 ID。 | lsr-bp1s0vzbi5bxlx5pw**** |
AcceleratorId | string | 是 | 全球加速實例 ID。 | ga-bp17frjjh0udz4qzk**** |
ForwardingRuleId | string | 否 | 轉發策略 ID。 | frule-bp19a3t3yzr21q3**** |
NextToken | string | 否 | 是否擁有下一次查詢的令牌(Token)。取值:
| FFmyTO70tTpLG6I3FmYAXGKPd**** |
MaxResults | integer | 否 | 分批次查詢時每次顯示的條目數。取值范圍:1~100。默認值:20。 | 20 |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "CFC67ED9-4AB1-431F-B6E3-A752B7B8CCD4",
"TotalCount": 1,
"NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
"MaxResults": 20,
"ForwardingRules": [
{
"Priority": 1000,
"ForwardingRuleId": "frule-bp19a3t3yzr21q3****",
"ForwardingRuleName": "auto_named_rule",
"ForwardingRuleDirection": "request",
"ForwardingRuleStatus": "active",
"RuleConditions": [
{
"RuleConditionType": "Host",
"RuleConditionValue": "[\"www.example.com\", \"www.aliyun.com\"]",
"PathConfig": {
"Values": [
"/test"
]
},
"HostConfig": {
"Values": [
"www.example.com"
]
}
}
],
"RuleActions": [
{
"Order": 1,
"RuleActionType": "ForwardGroup",
"RuleActionValue": "[{\"type\":\"endpointgroup\", \"value\":\"epg-bp1enpdcrqhl78g6r****\"}]",
"ForwardGroupConfig": {
"ServerGroupTuples": [
{
"EndpointGroupId": "epg-bp1enpdcrqhl78g6r****"
}
]
}
}
],
"ListenerId": "lsr-bp1s0vzbi5bxlx5****",
"ServiceId": "ALB",
"ServiceManaged": true,
"ServiceManagedInfos": [
{
"Action": "Update",
"ChildType": "Listener",
"IsManaged": false
}
]
}
]
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | NotExist.Listener | The listener does not exist. | 監聽器不存在 |
400 | NotActive.Listener | The state of the listener is not active. | 監聽器狀態非穩態 |
400 | NotExist.Accelerator | The accelerated instance does not exist. | 加速實例不存在。 |
400 | StateError.Accelerator | The state of the accelerated instance is invalid. | 加速實例狀態非法。 |
400 | NotExist.BusinessRegion | The business region does not exist. | 業務region并不存在 |
400 | NotExist.BasicBandwidthPackage | You must specify the basic bandwidth package. | 缺少基礎帶寬包 |
400 | QuotaExceeded.EndPoint | The maximum number of endpoints is exceeded. | 終端節點達到Quota限制 |
400 | Exist.EndpointGroup | The endpoint group already exists. | 終端節點組已存在 |
400 | NoPermission.VpcEndpoint | You are not authorized to perform the operation. | 用戶沒有創建服務關聯角色的權限,請聯系主賬號或權限管理員授權當前用戶AliyunGlobalAccelerationFullAccess或者創建服務關聯角色的自定義權限。自定義權限策略的相關信息包含以下內容:ServiceName為vpcendpoint.ga.aliyuncs.com,服務關聯角色名稱為AliyunServiceRoleForGaVpcEndpoint,執行該操作所需的用戶權限為ram:CreateServiceLinkedRole。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-08-30 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-08-15 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |