Update API Gateway Instance Settings with ModifyInstanceAttribute - API Gateway

Modifies the properties of an API Gateway instance.

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:ModifyInstanceAttribute

update

*Instance

acs:apigateway:{#regionId}:{#accountId}:instance/{#InstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance.	apigateway-ht-8xxxxxxxxx
InstanceName	string	No	Instance Name	apigatewayInstance
HttpsPolicy	string	No	The HTTPS policy.	HTTPS2_TLS1_0
IPV6Enabled	string	No	If enable inbound IPv6 Traffic.	true
EgressIpv6Enable	string	No	If enable outbound IPv6 Traffic.	true
VpcSlbIntranetEnable	string	No	Specifies whether to enable the self-calling domain name.	false
Token	string	No	The token of the request.	c20d86c4-1eb3-4d0b-afe9-c586df1e2136
IntranetSegments	string	No	Custom private CIDR block.	172.0.0.1/24
MaintainStartTime	string	No	Maintainable start time.	18:00Z
MaintainEndTime	string	No	Maintainable end time.	23:00Z
ToConnectVpcIpBlock	object	No	The information about the CIDR block that API Gateway can use to access the virtual private cloud (VPC) of the backend service.
VswitchId	string	No	The vSwitch ID.	vsw-wz94cqvaoe1ipxxxxxx
ZoneId	string	No	The zone ID.	cn-hangzhou-a
CidrBlock	string	No	The CIDR block of the VSwitch.	172.16.0.0/16
Customized	boolean	No	Specifies whether the CIDR block is a custom CIDR block.	false
DeleteVpcIpBlock	string	No	If delete VPC Ip block.	true

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	F3186326-2C57-58E1-B6E9-XXXXXXXXXXXX

Examples

Success response

JSON format

{
  "RequestId": "F3186326-2C57-58E1-B6E9-XXXXXXXXXXXX"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.