使用DescribeIstioGatewayRouteDetail擷取網關路由詳情-服務網格-阿里雲

調用DescribeIstioGatewayRouteDetail查看網關路由詳情。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

servicemesh:DescribeIstioGatewayRouteDetail

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
ServiceMeshId	string	是	服務網格執行個體 ID。	c08ba3fd1e6484b0f8cc1ad8fe10d****
IstioGatewayName	string	否	ASM 網關名稱。	ingressgateway
RouteName	string	否	路由名稱。	demo-route

返回參數

名稱	類型	描述	樣本值
	object	響應內容。
RouteDetail	object	路由詳情
RouteName	string	路由名稱。	demo-route
RouteType	string	路由類型，取值`HTTP`、`TLS`、`TCP`。	HTTP
MatchRequest	object	路由匹配規則。
URI	object	URI 匹配規則。
MatchingMode	string	路由規則匹配模式，取值： `exact`：精準匹配。 `prefix`：首碼匹配。 `regex`：正則匹配。	prefix
MatchingContent	string	用於匹配的內容。	/ratings/v2/
Headers	array<object>	用於判斷是否匹配的要求標頭部列表。
	object	用於判斷是否匹配的要求標頭部。
Name	string	Header 匹配的鍵。	x-request-id
MatchingMode	string	Header 值匹配方式，取值： `exact`：精準匹配。 `prefix`：首碼匹配。 `regex`：正則匹配。	exact
MatchingContent	string	用於 Header 匹配的內容。	v1
TLSMatchAttributes	array<object>	TLS 串連匹配屬性列表。
	object	TLS 串連匹配屬性。
TLSPort	integer	TLS 連接埠。	443
SNIHosts	array	伺服器名稱識別欄位表。
	string	SNI 值中可以使用萬用字元首碼，例如`*.com`將匹配`foo.example.com`和`example.com`。說明 SNI 值必須是相應虛擬服務主機的子集。	*.com
Ports	array	連接埠列表。
	integer	指定主機上要定址的連接埠。	443
HTTPAdvancedOptions	object	HTTP 路由進階配置選項。
HTTPRedirect	object	HTTP 重新導向。
Uri	string	在重新導向時，使用此值覆蓋 URL 的路徑部分。	/v1/getProductRatings
Authority	string	在重新導向時，使用此值覆蓋 URL 的 Authority 或 Host 部分。	newratings.default.svc.cluster.local
RedirectCode	integer	在重新導向上，指定要在重新導向響應中使用的 HTTP 狀態碼。預設響應代碼為 301。	301
Delegate	object	虛擬服務流量代理。
Name	string	名稱。	reviews
Namespace	string	命名空間。	default
Rewrite	object	重寫虛擬服務。
Uri	string	用這個值重寫 URI 的路徑（或首碼）部分。	/v1/getProductRatings
Authority	string	使用此值重寫 Authority 或 Host 頭。	newratings.default.svc.cluster.local
Timeout	string	逾時時間長度。	5s
Retries	object	請求重試配置。
Attempts	integer	給定請求允許的重試次數。	3
PerTryTimeout	string	請求的每次嘗試逾時時間。	2s
RetryOn	string	用於指定重試發生的條件，例如`connect-failure,refused-stream,503`。	connect-failure,refused-stream,503
RetryRemoteLocalities	object	用於指定重試是否應重試到其他位置的標誌。
Value	boolean	用於指定重試是否應重試到其他位置的標誌，取值： `true`：其他位置也重試 `false`：其他位置不重試預設`false`。	false
Fault	object	故障注入設定。
Delay	object	設定延遲。
FixedDelay	string	固定延遲時間。	5s
ExponentialDelay	string	指數型延遲等待時間，等待時間為 2 的 x 次方，x 為輸入參數。	3
Percentage	object	將注入延遲的請求的百分比。
Value	number	使用提供的錯誤碼中止的請求的百分比，用小數表示。	0.1
Abort	object	提前中止帶有預先指定的錯誤碼的請求。
HttpStatus	integer	HTTP 狀態代碼。	400
Percentage	object	使用提供的錯誤碼中止的請求的百分比。
Value	number	流量鏡像百分比。用小數表示	0.1
Mirror	object	除了將請求轉寄到預期目標之外，還將 HTTP 通訊鏡像到另一個目標。
Host	string	服務註冊表中服務的名稱。	reviews.default.svc.cluster.local
Subset	string	服務中子集的名稱	v1
MirrorPercentage	object	使用提供的錯誤碼中止的請求的百分比。
Value	number	使用提供的錯誤碼中止的請求的百分比，用小數表示。	0.2
RouteDestinations	array<object>	L4 路由規則加權目的地列表。
	object	L4 路由規則加權目的地。
Destination	object	Destination 唯一標識請求或串連應轉寄到的服務執行個體。
Host	string	服務註冊表中服務的名稱。	reviews
Subset	string	服務中子集的名稱。	v1
Port	object	連接埠列表。
Number	integer	指定主機上要定址的連接埠。	443
Weight	integer	流量權重，範圍：1~100。	80
Headers	object	用於判斷是否匹配的要求標頭部列表。
Request	object	用於判斷是否匹配的要求標頭部。
Set	object	用給定值覆蓋鍵指定的 Header。
	string	輸入 Value 值覆蓋鍵 Header。	key
Add	object	添加值到 Header 中。	key
Remove	array	刪除 Header 中的值。
	string	輸入要刪除的 Key。	key
Response	object	返迴響應前做的處理。
Set	object	用給定值覆蓋鍵指定的 Header。	key
Add	object	添加值到 Header 中。	key
Remove	array	刪除 Header 中的值。
	string	輸入要刪除的 Key。	key
Domains	array	匹配的請求網域名稱列表
	string	匹配的請求網域名稱	test.asm.aliyun.com
RawVSRoute	string	序列化為 JSON 的 VirtualService 原始 YAML	{}
HasUnsafeFeatures	boolean	如果為 True，說明原始 YAML 中包含有當前介面上不支援的特性。	true
RequestId	string	請求 ID。	31d3a0f0-07ed-4f6e-9004-1804498c****
Priority	integer	路由優先順序。整數，數字越小，優先順序越高。	1
Status	integer	網關路由狀態，取值： `0`：線上。 `1`：下線。 `2`：建立或更新錯誤。	1
Description	string	路由描述。	demo route
Namespace	string	命名空間	default

樣本

正常返回樣本

JSON格式

{
  "RouteDetail": {
    "RouteName": "demo-route",
    "RouteType": "HTTP",
    "MatchRequest": {
      "URI": {
        "MatchingMode": "prefix",
        "MatchingContent": "/ratings/v2/"
      },
      "Headers": [
        {
          "Name": "x-request-id",
          "MatchingMode": "exact",
          "MatchingContent": "v1"
        }
      ],
      "TLSMatchAttributes": [
        {
          "TLSPort": 443,
          "SNIHosts": [
            "*.com"
          ]
        }
      ],
      "Ports": [
        443
      ]
    },
    "HTTPAdvancedOptions": {
      "HTTPRedirect": {
        "Uri": "/v1/getProductRatings",
        "Authority": "newratings.default.svc.cluster.local",
        "RedirectCode": 301
      },
      "Delegate": {
        "Name": "reviews",
        "Namespace": "default"
      },
      "Rewrite": {
        "Uri": "/v1/getProductRatings",
        "Authority": "newratings.default.svc.cluster.local"
      },
      "Timeout": "5s",
      "Retries": {
        "Attempts": 3,
        "PerTryTimeout": "2s",
        "RetryOn": "connect-failure,refused-stream,503",
        "RetryRemoteLocalities": {
          "Value": false
        }
      },
      "Fault": {
        "Delay": {
          "FixedDelay": "5s",
          "ExponentialDelay": "3",
          "Percentage": {
            "Value": 0.1
          }
        },
        "Abort": {
          "HttpStatus": 400,
          "Percentage": {
            "Value": 0.1
          }
        }
      },
      "Mirror": {
        "Host": "reviews.default.svc.cluster.local",
        "Subset": "v1"
      },
      "MirrorPercentage": {
        "Value": 0.2
      }
    },
    "RouteDestinations": [
      {
        "Destination": {
          "Host": "reviews",
          "Subset": "v1",
          "Port": {
            "Number": 443
          }
        },
        "Weight": 80,
        "Headers": {
          "Request": {
            "Set": {
              "key": "key"
            },
            "Add": {
              "test": "test",
              "test2": 1
            },
            "Remove": [
              "key"
            ]
          },
          "Response": {
            "Set": {
              "test": "test",
              "test2": 1
            },
            "Add": {
              "test": "test",
              "test2": 1
            },
            "Remove": [
              "key"
            ]
          }
        }
      }
    ],
    "Domains": [
      "test.asm.aliyun.com"
    ],
    "RawVSRoute": "{}",
    "HasUnsafeFeatures": true
  },
  "RequestId": "31d3a0f0-07ed-4f6e-9004-1804498c****",
  "Priority": 1,
  "Status": 1,
  "Description": "demo route",
  "Namespace": "default"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
500	ERR500	An internal server error occurred.	後端服務異常

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。