API Gateway:ModifyVpcAccessAndUpdateApis - API Gateway

Modifies the information of a VPC access authorization and updates the metadata of the associated API.

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

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
VpcId	string	No	The ID of the new VPC.	vpc-m5e7jqfppv5wbvmdw5pg2
InstanceId	string	No	The ID of the new instance.	i-uf6bzcg1pr4oh5jjmxxx
Port	integer	No	The new port number.	80
Name	string	Yes	The name of the VPC authorization. Note The name of a VPC authorization cannot be changed. You cannot use this parameter to change the name of a VPC authorization. You must set this parameter to the name of the current VPC authorization.	VpcName
Token	string	No	The token of the request.	c20d86c4-1eb3-4d0b-afe9-c586df1e2136
NeedBatchWork	boolean	No	Specifies whether to update the associated API. Warning:** If you want to update the VPC authorization of a published API, you must set this parameter to true. Otherwise, the update will not be synchronized to the backend service of the API.	true
Refresh	boolean	No	Specifies whether to update the VPC authorization. Note If the ID of the instance in your VPC is changed but the IP address of the instance remains unchanged, you can set this parameter to true to update the VPC authorization.	false
VpcTargetHostName	string	No	The hostname of the backend service.	iot.hu***ng.com

Response elements

Element	Type	Description	Example
	object
OperationId	string	The ID of the asynchronous task. Note If the associated API is updated, you can use the task ID in the DescribeUpdateVpcInfoTask operation to query the update result.	7b6d0cb72b2e4215b0129f675c889746
RequestId	string	The ID of the request.	C2CEC6EA-EEBA-5FD6-8BD9-2CF01980FE39

Examples

Success response

JSON format

{
  "OperationId": "7b6d0cb72b2e4215b0129f675c889746",
  "RequestId": "C2CEC6EA-EEBA-5FD6-8BD9-2CF01980FE39"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.