All Products
Search
Document Center

API Gateway:GetHttpApiOperation

Last Updated:Dec 17, 2025
This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Get Operation

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
apig:GetHttpApiOperationget
*HttpApi
acs:apig:{#regionId}:{#accountId}:httpapi/{#HttpApiId}
    none
none

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
httpApiIdstringYes

The HTTP API ID to which the operation belongs.

api-xxx
operationIdstringYes

The operation ID.

op-xxx

Response parameters

ParameterTypeDescriptionExample
object

Response.

requestIdstring

Request ID.

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

Response status code.

Ok
messagestring

Response message.

success
dataHttpApiOperationInfo

Operation information.

Examples

Sample success responses

JSONformat

{
  "requestId": "B725275B-50C6-5A49-A9FD-F0332FCB3351",
  "code": "Ok",
  "message": "success",
  "data": {
    "operationId": "op-xxx",
    "method": "GET",
    "name": "GetUserInfo",
    "path": "/user/123",
    "description": "A example operation.",
    "response": {
      "contentType": "application/json",
      "items": [
        {
          "code": 200,
          "example": {
            "result": "ok"
          },
          "description": "This is a description.",
          "jsonSchema": {
            "type": "object",
            "required": [
              "result"
            ],
            "properties": {
              "result": {
                "type": "string",
                "description": "This is a description."
              }
            }
          }
        }
      ]
    },
    "request": {
      "headerParameters": [
        {
          "name": "userId",
          "required": true,
          "type": "String",
          "defaultValue": 123,
          "exampleValue": 123,
          "description": "The example description."
        }
      ],
      "queryParameters": [
        {
          "name": "userId",
          "required": true,
          "type": "String",
          "defaultValue": 123,
          "exampleValue": 123,
          "description": "The example description."
        }
      ],
      "pathParameters": [
        {
          "name": "userId",
          "required": true,
          "type": "String",
          "defaultValue": 123,
          "exampleValue": 123,
          "description": "The example description."
        }
      ],
      "body": {
        "description": "This is a description.",
        "example": {
          "result": "ok"
        },
        "contentType": "application/json",
        "jsonSchema": {
          "type": "object",
          "required": [
            "result"
          ],
          "properties": {
            "result": {
              "type": "string",
              "description": "Operation result. 'ok' indicates success."
            }
          }
        }
      }
    },
    "mock": {
      "enable": false,
      "responseCode": 200,
      "responseContent": "Mock content."
    },
    "createTimestamp": 1719386834548,
    "enableAuth": true,
    "authConfig": {
      "authType": "Jwt",
      "authMode": "NoAuth"
    }
  }
}

Error codes

For a list of error codes, visit the Service error codes.