All Products
Search
Document Center

API Gateway:DeleteApiGroup

Last Updated:Mar 01, 2024

Deletes an API group.

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.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:
    • The required resource types are displayed in bold characters.
    • 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:DeleteApiGroupWrite
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
GroupIdstringYes

The ID of the API group. This ID is generated by the system and globally unique.

523e8dc7bbe04613b5b1d726c2a7889d
Tagobject []No

The object tags that match the lifecycle rule. You can specify multiple tags.

Key, Value
KeystringYes

The key of the tag.

key
ValuestringYes

The value of the tag.

value

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

E8515BA6-81CD-4191-A7CF-C4FCDD3C0D99

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
No change history