All Products
Search

This Product

    API Gateway:ModifyApiGroup

    Document Center

    API Gateway:ModifyApiGroup

    Last Updated:Dec 24, 2025

    Modifies the name, description, or base path of an existing API group.

    Operation description

    • This feature is for API providers.

    • The queries per second (QPS) limit for this API operation is 50 for a single 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:ModifyApiGroup

    update

    *ApiGroup

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

    None

    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 is globally unique.

    523e8dc7bbe04613b5b1d726c2a7889d

    GroupName

    string

    No

    The name of the API group. The name must be unique and 4 to 50 characters in length. It must start with a letter or a Chinese character and can contain letters, digits, underscores (_), and Chinese characters. If you do not specify this parameter, the name is not modified.

    NewWeather

    BasePath

    string

    No

    The root path of the API.

    /eeee

    Description

    string

    No

    The description of the API group. The description can be up to 180 characters in length. If you do not specify this parameter, the description is not modified.

    New weather informations.

    UserLogConfig

    string

    No

    The user log configuration.

    {\"requestBody\":false,\"responseBody\":false,\"queryString\":\"\",\"requestHeaders\":\"\",\"responseHeaders\":\"\",\"jwtClaims\":\"\"}

    CustomTraceConfig

    string

    No

    The custom trace configuration.

    {\"parameterLocation\":\"HEADER\",\"parameterName\":\"traceId\"}

    CompatibleFlags

    string

    No

    A list of associated tags. Separate multiple tags with commas (,).

    depart:dep1

    CustomerConfigs

    string

    No

    The custom configuration item data.

    removeResponseServerHeader

    PassthroughHeaders

    string

    No

    The headers to be passed through.

    eagleeye-rpcid,x-b3-traceid,host

    DefaultDomain

    string

    No

    The default domain name.

    mkt.api.gaore.com

    RpcPattern

    string

    No

    The RPC pattern.

    {}

    Tag

    array<object>

    No

    The object tags to which the rule applies. You can specify multiple tags.

    Key， Value

    object

    No

    A list of tags.

    Key

    string

    Yes

    The tag key.

    env

    Value

    string

    Yes

    The tag value.

    uat

    SupportSSE

    string

    No

    Specifies whether the gateway can send event streams to the client to implement real-time data push.

    true

    FilterAppCodeForBackend

    string

    No

    Specifies whether to filter the app code from backend requests.

    false

    CustomAppCodeConfig

    string

    No

    The custom app code configuration.

    {"location":"HEADER","name":"myAppCodeHeader"}

    RpsLimitForServerless

    string

    No

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The unique ID of the request.

    4CF287C6-CE5B-477B-BE27-C48F99EADBC8

    BasePath

    string

    The root path of the API.

    /test

    GroupId

    string

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

    523e8dc7bbe04613b5b1d726c2a7889d

    GroupName

    string

    The name of the API group.

    NewWeather

    Description

    string

    The description of the API group.

    New weather informations.

    SubDomain

    string

    The second-level domain name that the system assigns to the API group.

    523e8dc7bbe04613b5b1d726c2a7889d-cn-hangzhou.alicloudapi.com

    Examples

    Success response

    JSON format

    {
  "RequestId": "4CF287C6-CE5B-477B-BE27-C48F99EADBC8",
  "BasePath": "/test",
  "GroupId": "523e8dc7bbe04613b5b1d726c2a7889d",
  "GroupName": "NewWeather",
  "Description": "New weather informations.",
  "SubDomain": "523e8dc7bbe04613b5b1d726c2a7889d-cn-hangzhou.alicloudapi.com"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.