All Products
Search
Document Center

API Gateway:ModifyInstanceAttribute

Last Updated:Jul 31, 2025

Modifies the properties of an API Gateway instance.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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:ModifyInstanceAttributeupdate
*Instance
acs:apigateway:{#regionId}:{#accountId}:instance/{#InstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the instance.

apigateway-ht-8xxxxxxxxx
InstanceNamestringNo

Instance Name

apigatewayInstance
HttpsPolicystringNo

The HTTPS policy.

HTTPS2_TLS1_0
IPV6EnabledstringNo

If enable inbound IPv6 Traffic.

true
EgressIpv6EnablestringNo

If enable outbound IPv6 Traffic.

true
VpcSlbIntranetEnablestringNo

Specifies whether to enable the self-calling domain name.

false
TokenstringNo

The token of the request.

c20d86c4-1eb3-4d0b-afe9-c586df1e2136
IntranetSegmentsstringNo

Custom private CIDR block.

172.0.0.1/24
MaintainStartTimestringNo

Maintainable start time.

18:00Z
MaintainEndTimestringNo

Maintainable end time.

23:00Z
ToConnectVpcIpBlockobjectNo

The information about the CIDR block that API Gateway can use to access the virtual private cloud (VPC) of the backend service.

VswitchIdstringNo

The vSwitch ID.

vsw-wz94cqvaoe1ipxxxxxx
ZoneIdstringNo

The zone ID.

cn-hangzhou-a
CidrBlockstringNo

The CIDR block of the VSwitch.

172.16.0.0/16
CustomizedbooleanNo

Specifies whether the CIDR block is a custom CIDR block.

false
DeleteVpcIpBlockstringNo

If delete VPC Ip block.

true

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

F3186326-2C57-58E1-B6E9-XXXXXXXXXXXX

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
No change history