GetHttpApiOperation - 获取接口信息

获取接口信息。

调试

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

授权信息

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

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

请求语法

GET /v1/http-apis/{httpApiId}/operations/{operationId} HTTP/1.1

请求参数

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

接口所属的 HTTP API ID。

api-xxx
operationIdstring

接口 ID。

op-xxx

返回参数

名称类型描述示例值
object

响应。

requestIdstring

请求 ID。

B725275B-50C6-5A49-A9FD-F0332FCB3351
codestring

响应状态码。

Ok
messagestring

响应消息。

success
dataHttpApiOperationInfo

接口信息。

示例

正常返回示例

JSON格式

{
  "requestId": "B725275B-50C6-5A49-A9FD-F0332FCB3351",
  "code": "Ok",
  "message": "success",
  "data": {
    "operationId": "op-xxx",
    "method": "GET",
    "name": "GetUserInfo",
    "path": "/user/123",
    "description": "获取用户信息",
    "response": {
      "contentType": "application/json",
      "items": [
        {
          "code": 200,
          "example": "{\"result\": \"ok\"}",
          "description": "正常接口响应",
          "jsonSchema": "{\n    \"type\": \"object\",\n    \"required\": [\n        \"result\"\n    ],\n    \"properties\": {\n        \"result\": {\n            \"type\": \"string\",\n            \"description\": \"操作结果,'ok' 表示成功\"\n        }\n    }\n}"
        }
      ]
    },
    "request": {
      "headerParameters": [
        {
          "name": "userId",
          "required": true,
          "type": "String",
          "defaultValue": "123",
          "exampleValue": "123",
          "description": "用户ID"
        }
      ],
      "queryParameters": [
        {
          "name": "userId",
          "required": true,
          "type": "String",
          "defaultValue": "123",
          "exampleValue": "123",
          "description": "用户ID"
        }
      ],
      "pathParameters": [
        {
          "name": "userId",
          "required": true,
          "type": "String",
          "defaultValue": "123",
          "exampleValue": "123",
          "description": "用户ID"
        }
      ],
      "body": {
        "description": "body参数描述",
        "example": "{\"result\":\"ok\"}",
        "contentType": "application/json",
        "jsonSchema": "{\n    \"type\": \"object\",\n    \"required\": [\n        \"result\"\n    ],\n    \"properties\": {\n        \"result\": {\n            \"type\": \"string\",\n            \"description\": \"操作结果,'ok' 表示成功\"\n        }\n    }\n}\n"
      }
    },
    "mock": {
      "enable": false,
      "responseCode": 200,
      "responseContent": "Mock测试"
    },
    "createTimestamp": 1719386834548
  }
}

错误码

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