All Products
Search

This Product

    Smart Access Gateway:AssociateSmartAGWithApplicationBandwidthPackage

    Document Center

    Smart Access Gateway:AssociateSmartAGWithApplicationBandwidthPackage

    Last Updated:Mar 29, 2024

    Associates a bandwidth plan for application acceleration with a Smart Access Gateway (SAG) instance.

    Operation description

    Before you associate a bandwidth plan for application acceleration with an SAG instance, make sure that the following requirements are met:

    • If you want to associate a bandwidth plan for application acceleration with an SAG CPE instance, the version of the SAG device associated with the SAG CPE instance must be 2.4.0 or later.

      If the version of the SAG device is earlier than 2.4.0, update it. For more information, see Update the version of an SAG device.

    • If you want to associate a bandwidth plan for application acceleration with an SAG app instance, the version of the SAG app must be 2.4.0 or later.

      If the version of the SAG app is earlier than 2.4.0, update it. For more information, see Install the SAG app.

    • The SAG instance to be associated is in the available state.

    Debugging

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

    Authorization information

    There is currently no authorization information disclosed in the API.

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DryRunbooleanNo

    Specifies whether to precheck the request. Check items include permissions and the status of the specified cloud resources. Valid values:

    • false (default): sends the request. After the request passes the check, the bandwidth plan for application acceleration is associated with the SAG instance.
    • true: prechecks the request but does not associate the bandwidth plan for application acceleration with the SAG instance. If you use this value, the system checks the required parameters and the request syntax. If the request fails the precheck, an error message is returned. If the request passes the precheck, the DryRunOperation error code is returned.
    		false
    ClientTokenstringNo

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

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

    Note If you do not set this parameter, ClientToken is set to the value of RequestId. The value of RequestId for each API request may be different.
    		02fb3da4-130e-11e9-8e44-001****
    RegionIdstringYes

    The region ID of the bandwidth plan for application acceleration.

    You can call the DescribeRegions operation to query the most recent region list.

    		cn-shanghai
    ApplicationBandwidthPackageIdstringYes

    The ID of the bandwidth plan for application acceleration.

    		abwp-7963l7iqnquyj3****
    AssociateConfigsobject []Yes

    The configuration of application acceleration.

    SmartAGIdstringYes

    The ID of the SAG instance.

    		sag-gf5serujbhrn2j****
    BandwidthintegerYes

    The maximum bandwidth value for application acceleration. Unit: Mbit/s.

    Note The maximum bandwidth value of each SAG instance cannot exceed that of the associated bandwidth plan for application acceleration.
    		2

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    		AFF2FD9D-66BD-4DD4-8152-C4508119D7B1

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "AFF2FD9D-66BD-4DD4-8152-C4508119D7B1"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400UnsupportedFeature.ApplicationAccelerateThe feature of ApplicationAccelerate is not supported.Application acceleration is not supported.
    400ResourceNotFound.ApplicationBandwidthPackageThe specified resource of ApplicationBandwidthPackage is not found.-
    400OperationDenied.NoBindCcnThe CCN is not associated. The operation is denied.The operation has been denied because the resource e is not associated with a CCN instance.
    400OperationDenied.ArrearageThe operation is denied due to overdue payment.The operation has been denied due to overdue payments.
    400IncorrectBusinessStatus.ApplicationBandwidthPackageThe business status of ApplicationBandwidthPackage is incorrect.The status of the application acceleration bandwidth plan is invalid.
    400ResourceAlreadyAssociated.SmartAccessGatewayThe specified resource of SmartAccessGateway is already associated.The resource is already associated with the specified SAG instance.
    404ResourceNotFound.SmartAccessGatewayThe specified resource of SmartAccessGateway is not found.-

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