GetHttpApiRoute - 查询路由详情

获取HttpApi的路由详情。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
apig:GetHttpApiRoutenone
*HttpApi
acs:apig:{#regionId}:{#accountId}:httpapi/{#HttpApiId}

请求语法

GET /v1/http-apis/{httpApiId}/routes/{routeId} HTTP/1.1

请求参数

名称类型必填描述示例值
httpApiIdstring

HTTP API ID。

api-cqu95allhtgii6***
routeIdstring

路由 ID。

hr-cr82undlhtgrl***

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

请求 ID。

3ACFC7A7-45A9-58CF-B2D5-765B60254695
codestring

响应状态码。

Ok
messagestring

响应消息。

success
dataHttpRoute

路由详情数据。

示例

正常返回示例

JSON格式

{
  "requestId": "3ACFC7A7-45A9-58CF-B2D5-765B60254695",
  "code": "Ok",
  "message": "success",
  "data": {
    "routeId": "",
    "name": "",
    "deployStatus": "",
    "description": "",
    "match": {
      "ignoreUriCase": true,
      "path": {
        "type": "Prefix",
        "value": "/user"
      },
      "headers": [
        {
          "type": "Exact",
          "name": "dev",
          "value": "true"
        }
      ],
      "methods": [
        "GET"
      ],
      "queryParams": [
        {
          "type": "Exact",
          "name": "age",
          "value": "17"
        }
      ]
    },
    "backend": {
      "scene": "Single",
      "services": [
        {
          "serviceId": "service-cq2bmmdlhtgj***",
          "name": "item-service",
          "protocol": "HTTP",
          "port": 0,
          "weight": 49,
          "version": "v1"
        }
      ]
    },
    "domainInfos": [
      {
        "domainId": "",
        "name": "",
        "protocol": ""
      }
    ],
    "environmentInfo": {
      "environmentId": "",
      "name": "",
      "alias": "",
      "gatewayInfo": {
        "gatewayId": "",
        "name": ""
      },
      "subDomains": [
        {
          "domainId": "",
          "name": "",
          "protocol": "",
          "networkType": "Internet"
        }
      ]
    },
    "createTimestamp": 0,
    "updateTimestamp": 0
  }
}

错误码

访问错误中心查看更多错误码。