edit-icon download-icon

Modify an API group

Last Updated: May 17, 2017

Description

This function is for modifying the name or description of an existing API group.

  • This function is intended for API providers.
  • This API can call up to 50 QPS for a single user.

Request parameters

Name Type Required? Description
Action String Yes Interface name, which is a required parameter; value: ModifyApiGroup.
GroupId String Yes API group ID, which is generated by the system and globally unique.
GroupName String No Group name, which must be globally unique and contain 4–50 characters including Chinese characters, English letters, numbers, and English-style underscores. The group name must start with an English letter or a Chinese character. If this parameter is not input, the group name is not modified.
Description String No API group description, which cannot exceed 180 characters. If this parameter is not input, the group description is not modified.

Returned parameters

Name Type Description
RequestId String Unique request ID.
GroupID String API group ID, which is generated by the system and globally unique.
GroupName String API group name.
SubDomain String Second-level domain name automatically assigned to the API group.
Description String API group description.

Examples

Request example

  1. http://apigateway.cn-hangzhou.aliyuncs.com?Action=ModifyApiGroup
  2. &Description=New weather informations.
  3. &GroupId=523e8dc7bbe04613b5b1d726c2a7889d
  4. &GroupName=NewWeather
  5. &<Public request parameters>

Response example

XML format

  1. <ModifyApiGroupResponse>
  2. <RequestId>4CF287C6-CE5B-477B-BE27-C48F99EADBC8</RequestId>
  3. <GroupId>523e8dc7bbe04613b5b1d726c2a7889d</GroupId>
  4. <GroupName>NewWeather</GroupName>
  5. <SubDomain>523e8dc7bbe04613b5b1d726c2a7889d-cn-hangzhou.alicloudapi.com</SubDomain>
  6. <Description>New weather informations.</Description>
  7. </ModifyApiGroupResponse>

JSON format

  1. {
  2. "RequestId": "4CF287C6-CE5B-477B-BE27-C48F99EADBC8",
  3. "GroupId": "523e8dc7bbe04613b5b1d726c2a7889d",
  4. "GroupName": "NewWeather",
  5. "SubDomain":"523e8dc7bbe04613b5b1d726c2a7889d-cn-hangzhou.alicloudapi.com"
  6. "Description": "New weather informations."
  7. }
Thank you! We've received your feedback.