All Products
Search

This Product

    Global Accelerator:UpdateIpSet

    Document Center

    Global Accelerator:UpdateIpSet

    Last Updated:Apr 10, 2024

    Modifies the attributes of an acceleration region in an acceleration area for a Global Accelerator (GA) instance.

    Operation description

    • UpdateIpSet is an asynchronous operation. After you send a request, the system returns a request ID and runs the task in the background. You can call the DescribeIpSet operation to query the status of an acceleration region.

      • If the acceleration region is in the updating state, it indicates that the acceleration region is being modified. In this case, you can continue to perform query operations on the acceleration regions.
      • If the acceleration region is in the active state, it indicates that the acceleration region is modified.

    • You cannot call the UpdateIpSet operation again on the same GA instance before the previous operation is complete.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    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:
      • The required resource types are displayed in bold characters.
      • 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
    ga:UpdateIpSetWrite
    • IpSet
      acs:ga:{#regionId}:{#accountId}:ipset/{#ipSetId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

    The ID of the region where the GA instance is deployed. Set the value to cn-hangzhou.

    		cn-hangzhou
    ClientTokenstringNo

    The client token that is used to ensure the idempotence of the request.

    You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.

    Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.
    		7D2F7E4E-B958-439C-9821-56D6213A31EC
    IpSetIdstringYes

    The ID of the acceleration region that you want to modify.

    		ips-bp11r5jb8ogp122xl****
    BandwidthintegerYes

    The new bandwidth that you want to allocate to the acceleration region. Unit: Mbit/s.

    You must allocate at least 2 Mbit/s of bandwidth to each acceleration region.

    		3

    Response parameters

    ParameterTypeDescriptionExample
    object

    A list of response parameters.

    RequestIdstring

    The ID of the request.

    		7D2F7E4E-B958-439C-9821-56D6213A31EC

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "7D2F7E4E-B958-439C-9821-56D6213A31EC"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400Resource.QuotaFullThe resource quota is exceeded.The number of resources has reached the upper limit.
    400NotExist.IpSetThe IpSet does not exist.The acceleration region does not exist.
    400StateError.IpSetThe state of IpSet is invalid.The acceleration region is in an invalid state.
    400NotExist.AcceleratorThe accelerated instance does not exist.The GA instance does not exist.
    400StateError.AcceleratorThe state of the accelerated instance is invalid.The status of the GA instance is invalid.
    400NotExist.BasicBandwidthPackageYou must specify the basic bandwidth package.You must specify the basic bandwidth package.
    400GreaterThanGa.IpSetBandwidthThe total bandwidth for IpSet exceeds the total bandwidth of the GA instance.The total bandwidth for IpSet exceeds the total bandwidth of the GA instance.
    403Forbbiden.SubUserYou are not authorized to operate on the specified resource because your account was created by another user.The current account is a RAM user and does not have permissions to manage the specified resources.
    403ForbiddenThe user is not authorized to operate on the specified resource.The current account does not have permissions to manage the specified resources.
    500UnknownErrorAn error occurred while processing your request. Please try again. If the error persists, please submit a ticket.An error occurred while the request was being processed. Try again later.

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

    Change history

    Change timeSummary of changesOperation
    No change history