DescribeUpdateVpcInfoTask - API Gateway - Alibaba Cloud Documentation Center

When you update a VPC authorization, the associated published APIs are updated asynchronously. You can call this operation to query the progress of these API updates.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
OperationUid	string	Yes	The task ID.	7d341787517a47afaaef9cc1bdb7acce

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	CEF72CEB-54B6-4AE8-B225-F876FF7BZ015
ApiUpdateVpcInfoResults	object
ApiUpdateVpcInfoResult	array<object>	The list of task results.
	object
StageId	string	The stage ID.	fe952b95072747e2a8dfd336bcff8d7f
UpdateStatus	string	The update status.	success
GroupId	string	The ID of the API group.	e8da6f6346184da9a30d0dc1888b1f3b
GroupName	string	The name of the API group.	test
ApiUid	string	The API ID.	86364e7c166c47ba819b3f8f95ac0913
ErrorMsg	string	The error message.	Success. Request Success.
StageName	string	The environment to which the API is published.	RELEASE
ApiName	string	The API name.	api_test2

Examples

Success response

JSON format

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ015",
  "ApiUpdateVpcInfoResults": {
    "ApiUpdateVpcInfoResult": [
      {
        "StageId": "fe952b95072747e2a8dfd336bcff8d7f",
        "UpdateStatus": "success",
        "GroupId": "e8da6f6346184da9a30d0dc1888b1f3b",
        "GroupName": "test",
        "ApiUid": "86364e7c166c47ba819b3f8f95ac0913",
        "ErrorMsg": "Success. Request Success.",
        "StageName": "RELEASE",
        "ApiName": "api_test2"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.