All Products
Search
Document Center

API Gateway:BatchDeployApis

Last Updated:Jul 31, 2025

Publishes multiple APIs at a time.

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
apigateway:BatchDeployApisupdate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
StageNamestringYes

The name of the runtime environment. Valid values:

  • RELEASE
  • TEST
  • PRE: the pre-release environment
RELEASE
DescriptionstringYes

The description.

test
Apiarray<object>No

The APIs that you want to publish.

objectNo
GroupIdstringYes

The API group ID.

b4f5c342b8bc4ef88ccda0332402e0fa
ApiUidstringYes

The API ID.

2b35dd68345b472f8051647306a16415

Response parameters

ParameterTypeDescriptionExample
object
OperationIdstring

The ID of the operation.

2a322599-8e38-428a-a306-9b21ea2129bf
RequestIdstring

The ID of the request.

E7FE7172-AA75-5880-B6F7-C00893E9BC06

Examples

Sample success responses

JSONformat

{
  "OperationId": "2a322599-8e38-428a-a306-9b21ea2129bf",
  "RequestId": "E7FE7172-AA75-5880-B6F7-C00893E9BC06"
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history