All Products
Document Center

Release an API

Last Updated: Feb 19, 2019


For releasing an API to a specified running stage.

  • The API is intended for API activators. The defined API can be called only when released to a running stage.
  • It takes at most 5 seconds to release an API to a cluster.
  • This API can call up to 50 QPS for a single user.

Request parameters

Name Type Required? Description
Action String Yes Operation interface, which is a required parameter; value: DeployApi.
GroupId String No ID of the group.
ApiId String Yes ID of the API.
StageName String Yes Name of the running stage; values:
  • RELEASE: Online
  • PRE: Prerelease
  • TEST: Test
Description String Yes Description on this release.

Return parameters

Name Type Description
RequestId String ID of the current request.


Request example

  2. &ApiId=d6f679aeb3be4b91b3688e887ca1fe16
  3. &StageName=release
  4. &Description=for_test1
  5. &<Public request parameters>

Response example

XML format

  1. <DeployApiResponse>
  2. <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ015</RequestId>
  3. </DeployApiResponse>

JSON format

  1. {
  2. "RequestId":"CEF72CEB-54B6-4AE8-B225-F876FF7BZ015"
  3. }