Delete API Groups via DeleteApiGroup - API Gateway

Operation description

This operation is intended for API providers.
An API group that contains APIs cannot be deleted. To delete the API group, you must first delete its APIs.
After an API group is deleted, the second-level domain name bound to the API group is automatically invalidated.
If the specified API group does not exist, a success response is returned.
The QPS limit on this operation is 50 per user.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

apigateway:DeleteApiGroup

delete

*ApiGroup

acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}

None

Request parameters

Parameter	Type	Required	Description	Example
GroupId	string	Yes	The ID of the API group. This ID is generated by the system and globally unique.	523e8dc7bbe04613b5b1d726c2a7889d
Tag	array<object>	No	The object tags that match the lifecycle rule. You can specify multiple tags.	Key， Value
	object	No
Key	string	Yes	The key of the tag.	key
Value	string	Yes	The value of the tag.	value

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	E8515BA6-81CD-4191-A7CF-C4FCDD3C0D99

Examples

Success response

JSON format

{
  "RequestId": "E8515BA6-81CD-4191-A7CF-C4FCDD3C0D99"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.