All Products
Document Center

Abolish an API

Last Updated: Feb 18, 2019


For abolishing a specified API in a specified stage.

  • This function is intended for users who release APIs and opposite to the function for releasing an API.
  • It takes no more than 5 seconds to abolish a specified API running in a running stage.
  • An abolished API cannot be called in the specified stage.

Request parameters

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

Return parameters

Name Type Description
RequestId String ID of the current request.


Request example

  2. &ApiId=d6f679aeb3be4b91b3688e887ca1fe16
  3. &StageName=RELEASE
  4. &<Public request parameters>

Response example

XML format

  1. <AbolishApiResponse>
  2. <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ016</RequestId>
  3. </AbolishApiResponse>

JSON format

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