ListHttpApiOperations - API Gateway - Alibaba Cloud Documentation Center

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.

List Operations

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
apig:ListHttpApiOperations	list	*HttpApi `acs:apig:{#regionId}:{#accountId}:httpapi/{#HttpApiId}`	none	none

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
httpApiId	string	Yes	Target HTTP API ID.	api-xxx
method	string	No	List interfaces by Method. Enumeration Value: TRACE: TRACE. HEAD: HEAD. DELETE: DELETE. POST: POST. GET: GET. CONNECT: CONNECT. OPTIONS: OPTIONS. PUT: PUT. PATCH: PATCH.	GET
pathLike	string	No	Search operations by path prefix.	/v1
nameLike	string	No	Search operations by name prefix.	GetUser
pageNumber	integer	No	Page number, starting from 1, default is 1 if not specified.	1
pageSize	integer	No	Page size, valid range [1, 100], default is 10 if not specified.	10
name	string	No	Search operations by exact name.	getUserInfo
withConsumerInEnvironmentId	string	No	Each operation information in the response carries a list of authorization rules for the specified consumer under the specified environment ID. The withConsumerInEnvironmentId field needs to be additionally specified.	env-xxx
withConsumerInfoById	string	No	Each operation information in the response carries a list of authorization rules for the specified consumer under the specified environment ID. The withConsumerInEnvironmentId field needs to be additionally specified.	cs-xxx
consumerAuthorizationRuleId	string	No	Filter the operation list based on a specific consumer authorization rule ID, and the interface list in the response only contains authorized operations.	cas-xxx
withPluginAttachmentByPluginId	string	No	Plugin ID, use this plugin ID to retrieve the plugin release information.	pl-xxx

Response parameters

Parameter	Type	Description	Example
	object	Response.
requestId	string	Request ID.	585657D2-1C20-5B8A-AF17-D727C6490BE4
code	string	Response status code.	Ok
message	string	Response message.	success
data	object	List of operations.
pageNumber	integer	Page number.	1
pageSize	integer	Page size.	10
totalSize	integer	Total count.	10
items	array	List of operations.
item	HttpApiOperationInfo	operation information.

Examples

Sample success responses

JSONformat

{
  "requestId": "585657D2-1C20-5B8A-AF17-D727C6490BE4",
  "code": "Ok",
  "message": "success",
  "data": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalSize": 10,
    "items": [
      {
        "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.

Change history

Change time	Summary of changes	Operation
2024-11-28	The request parameters of the API has changed	View Change Details
2024-10-24	The request parameters of the API has changed	View Change Details
2024-08-05	The request parameters of the API has changed	View Change Details