All Products
Search
Document Center

API Gateway:DescribeUpdateVpcInfoTask

Last Updated:Feb 09, 2023

Queries the update progress of an API that is being published after its associated VPC access authorization is updated.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
OperationUidstringYes

The ID of the task.

7d341787517a47afaaef9cc1bdb7acce

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

CEF72CEB-54B6-4AE8-B225-F876FF7BZ015
ApiUpdateVpcInfoResultsarray

The result of the task.

object
StageIdstring

The ID of the stage.

fe952b95072747e2a8dfd336bcff8d7f
UpdateStatusstring

The update status.

success
GroupIdstring

The ID of the API group.

e8da6f6346184da9a30d0dc1888b1f3b
GroupNamestring

The name of the API group.

test
ApiUidstring

The ID of the API.

86364e7c166c47ba819b3f8f95ac0913
ErrorMsgstring

The error message.

Success. Request Success.
StageNamestring

The environment to which the API is published.

RELEASE
ApiNamestring

The name of the API.

api_test2

Example

Normal return example

JSONFormat

{
  "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

For a list of error codes, visit the API error center.