Cloud Firewall commerce API

Background

The Alibaba Cloud Billing Management API provides a set of general-purpose APIs for managing Alibaba Cloud resources, allowing you to query service prices, manage instances, and retrieve billing information. For a list of all supported APIs, see the API overview.

You can use the Alibaba Cloud Trading and Bill Management API to query, create, modify, and renew Cloud Firewall instances. For information on how to call the API, see Request structure.

Query instances

Call QueryAvailableInstances to find available instances.

Debugging

You can run this API directly in OpenAPI Explorer without calculating a signature. On a successful call, it automatically generates an SDK code sample.

Request parameters

Response parameters

data

InstanceList

Example

Example request

// This file is auto-generated, don't edit it. Thanks.
package demo;

import com.aliyun.auth.credentials.Credential;
import com.aliyun.auth.credentials.provider.StaticCredentialProvider;
import com.aliyun.core.http.HttpClient;
import com.aliyun.core.http.HttpMethod;
import com.aliyun.core.http.ProxyOptions;
import com.aliyun.httpcomponent.httpclient.ApacheAsyncHttpClientBuilder;
import com.aliyun.sdk.service.bssopenapi20171214.models.*;
import com.aliyun.sdk.service.bssopenapi20171214.*;
import com.google.gson.Gson;
import darabonba.core.RequestConfiguration;
import darabonba.core.client.ClientOverrideConfiguration;
import darabonba.core.utils.CommonUtil;
import darabonba.core.TeaPair;

//import javax.net.ssl.KeyManager;
//import javax.net.ssl.X509TrustManager;
import java.net.InetSocketAddress;
import java.time.Duration;
import java.util.*;
import java.util.concurrent.CompletableFuture;
import java.io.*;

public class QueryAvailableInstances {
    public static void main(String[] args) throws Exception {

        // HttpClient Configuration
        /*HttpClient httpClient = new ApacheAsyncHttpClientBuilder()
                .connectionTimeout(Duration.ofSeconds(10)) // Set the connection timeout. The default is 10 seconds.
                .responseTimeout(Duration.ofSeconds(10)) // Set the response timeout. The default is 20 seconds.
                .maxConnections(128) // Set the connection pool size.
                .maxIdleTimeOut(Duration.ofSeconds(50)) // Set the idle connection timeout. The default is 30 seconds.
                // Configure the proxy.
                .proxy(new ProxyOptions(ProxyOptions.Type.HTTP, new InetSocketAddress("<your-proxy-hostname>", 9001))
                        .setCredentials("<your-proxy-username>", "<your-proxy-password>"))
                // For HTTPS, configure a certificate or ignore SSL validation (for example, .ignoreSSL(true)).
                .x509TrustManagers(new X509TrustManager[]{})
                .keyManagers(new KeyManager[]{})
                .ignoreSSL(false)
                .build();*/

        // Configure credentials. Use an AccessKey pair or an STS token.
        StaticCredentialProvider provider = StaticCredentialProvider.create(Credential.builder()
                // Ensure that the ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variables are set.
                .accessKeyId(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"))
                .accessKeySecret(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"))
                //.securityToken(System.getenv("ALIBABA_CLOUD_SECURITY_TOKEN")) // Uncomment to use an STS token.
                .build());

        // Configure the client.
        AsyncClient client = AsyncClient.builder()
                .region("cn-shanghai") // Region ID
                //.httpClient(httpClient) // Uncomment to use the custom HttpClient. Otherwise, the SDK uses the default Apache HttpClient.
                .credentialsProvider(provider)
                //.serviceConfiguration(Configuration.create()) // Service-level configuration
                // Override client-level configuration to set the endpoint, HTTP request parameters, and more.
                .overrideConfiguration(
                        ClientOverrideConfiguration.create()
                                  // For the endpoint, see https://api.aliyun.com/product/BssOpenApi
                                .setEndpointOverride("business.aliyuncs.com")
                        //.setConnectTimeout(Duration.ofSeconds(30))
                )
                .build();

        // Configure the API request parameters.
        QueryAvailableInstancesRequest queryAvailableInstancesRequest = QueryAvailableInstancesRequest.builder()
                .productCode("cfw")
                .productType("cfw_sub_public_cn")
                // Request-level override for settings like HTTP request parameters.
                // .requestConfiguration(RequestConfiguration.create().setHttpHeaders(new HttpHeaders()))
                .build();

        // Call the API asynchronously.
        CompletableFuture<QueryAvailableInstancesResponse> response = client.queryAvailableInstances(queryAvailableInstancesRequest);
        // Get the response synchronously.
        QueryAvailableInstancesResponse resp = response.get();
        System.out.println(new Gson().toJson(resp));
        // Process the response asynchronously.
        /*response.thenAccept(resp -> {
            System.out.println(new Gson().toJson(resp));
        }).exceptionally(throwable -> { // Handle exceptions.
            System.out.println(throwable.getMessage());
            return null;
        });*/

        // Close the client to release resources.
        client.close();
    }

}

Sample response

{
  "Message": "Successful!",
  "RequestId": "4A028827-4D32-5EAD-8771-************",
  "Data": {
    "TotalCount": 1,
    "PageNum": 1,
    "PageSize": 20,
    "InstanceList": [
      {
        "Status": "Normal",
        "SubscriptionType": "Subscription",
        "OwnerId": 13206399********,
        "EndTime": "2026-01-03T16:00:00Z",
        "InstanceID": "cfw_sub_public_cn-***********",
        "ProductCode": "cfw",
        "CreateTime": "2025-12-03T06:55:44Z",
        "ProductType": "cfw_sub_public_cn",
        "RenewalDurationUnit": "M",
        "Seller": "26842",
        "SubStatus": "Normal",
        "RenewStatus": "ManualRenewal"
      }
    ]
  },
  "Code": "Success",
  "Success": true
}

Create an instance

Call CreateInstance to create an instance. This action also creates an order and completes the payment.

Debugging

You can run this API directly in OpenAPI Explorer without needing to calculate a signature. After a successful call, OpenAPI Explorer automatically generates an SDK code example.

Request parameters

Parameter

Return parameters

Example

This code creates a prepaid Cloud Firewall instance in mainland China for one month with manual renewal.

Example request

// This file is auto-generated. Do not edit.
package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>Initializes a client with a credential.</p>
     * @return Client
     * 
     * @throws Exception
     */
    public static com.aliyun.bssopenapi20171214.Client createClient() throws Exception {
        // For production environments, we recommend a more secure credential method than using an access key. For more information about configuring credentials, see https://help.aliyun.com/document_detail/378657.html.
        com.aliyun.credentials.Client credential = new com.aliyun.credentials.Client();
        com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config()
                .setCredential(credential);
        // For endpoint details, see https://api.aliyun.com/product/BssOpenApi
        config.endpoint = "business.aliyuncs.com";
        return new com.aliyun.bssopenapi20171214.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        
        com.aliyun.bssopenapi20171214.Client client = Sample.createClient();
        com.aliyun.bssopenapi20171214.models.CreateInstanceRequest.CreateInstanceRequestParameter parameter0 = new com.aliyun.bssopenapi20171214.models.CreateInstanceRequest.CreateInstanceRequestParameter()
                .setValue("cfw_spec")
                .setCode("2");
        com.aliyun.bssopenapi20171214.models.CreateInstanceRequest createInstanceRequest = new com.aliyun.bssopenapi20171214.models.CreateInstanceRequest()
                .setProductCode("cfw")
                .setProductType("cfw_sub_public_cn")
                .setSubscriptionType("Subscription")
                .setPeriod(1)
                .setRenewalStatus("ManualRenewal")
                .setParameter(java.util.Arrays.asList(
                    parameter0
                ));
        com.aliyun.teautil.models.RuntimeOptions runtime = new com.aliyun.teautil.models.RuntimeOptions();
        try {
            // Call the API operation.
            client.createInstanceWithOptions(createInstanceRequest, runtime);
        } catch (TeaException error) {
            // This exception handling is for demonstration only. Implement proper exception handling in production code.
            System.out.println(error.getMessage());
            // The recommendation.
            System.out.println(error.getData().get("Recommend"));
            com.aliyun.teautil.Common.assertAsString(error.message);
        } catch (Exception _error) {
            TeaException error = new TeaException(_error.getMessage(), _error);
            // This exception handling is for demonstration only. Implement proper exception handling in production code.
            System.out.println(error.getMessage());
            // The recommendation.
            System.out.println(error.getData().get("Recommend"));
            com.aliyun.teautil.Common.assertAsString(error.message);
        }        
    }
}

Successful response

Creating a Cloud Firewall instance returns an instance ID (InstanceId). This ID is required for subsequent operations, such as specification changes and renewals.

{
  "RequestId": "13B1DCF7-0B7C-5426-BC08-************",
  "Message": "Successful!",
  "Data": {
    "InstanceId": "cfw_sub_public_cn-***********",
    "OrderId": 22165938636****
  },
  "Code": "Success",
  "Success": true
}

Modify instance

Use the ModifyInstance API to modify an instance's configuration. This creates an order and automatically processes the payment.

Debugging

You can run this API directly in OpenAPI Explorer without having to calculate a signature. After a successful call, OpenAPI Explorer automatically generates an SDK code sample.

Parameters

Parameter

Response parameters

Example

The following code upgrades the edition from Advanced to Enterprise.

Request example

// This file is auto-generated. Do not edit.
package demo;

import com.aliyun.auth.credentials.Credential;
import com.aliyun.auth.credentials.provider.StaticCredentialProvider;
import com.aliyun.core.http.HttpClient;
import com.aliyun.core.http.HttpMethod;
import com.aliyun.core.http.ProxyOptions;
import com.aliyun.httpcomponent.httpclient.ApacheAsyncHttpClientBuilder;
import com.aliyun.sdk.service.bssopenapi20171214.models.*;
import com.aliyun.sdk.service.bssopenapi20171214.*;
import com.google.gson.Gson;
import darabonba.core.RequestConfiguration;
import darabonba.core.client.ClientOverrideConfiguration;
import darabonba.core.utils.CommonUtil;
import darabonba.core.TeaPair;

//import javax.net.ssl.KeyManager;
//import javax.net.ssl.X509TrustManager;
import java.net.InetSocketAddress;
import java.time.Duration;
import java.util.*;
import java.util.concurrent.CompletableFuture;
import java.io.*;

public class ModifyInstance {
    public static void main(String[] args) throws Exception {

        // HttpClient configuration
        /*HttpClient httpClient = new ApacheAsyncHttpClientBuilder()
                .connectionTimeout(Duration.ofSeconds(10)) // Sets the connection timeout. Default: 10s.
                .responseTimeout(Duration.ofSeconds(10)) // Sets the response timeout. Default: 20s.
                .maxConnections(128) // Sets the connection pool size.
                .maxIdleTimeOut(Duration.ofSeconds(50)) // Sets the idle connection timeout. Default: 30s.
                // Configure the proxy.
                .proxy(new ProxyOptions(ProxyOptions.Type.HTTP, new InetSocketAddress("", 9001))
                        .setCredentials("", ""))
                // For an HTTPS connection, configure a certificate or ignore certificate validation.
                .x509TrustManagers(new X509TrustManager[]{})
                .keyManagers(new KeyManager[]{})
                .ignoreSSL(false)
                .build();*/

        // Configure credentials. Use an AccessKey pair or an STS token.
        StaticCredentialProvider provider = StaticCredentialProvider.create(Credential.builder()
                // Ensure the ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variables are set.
                .accessKeyId(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"))
                .accessKeySecret(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"))
                //.securityToken(System.getenv("ALIBABA_CLOUD_SECURITY_TOKEN")) // Uncomment to use an STS token.
                .build());

        // Configure the client.
        AsyncClient client = AsyncClient.builder()
                .region("cn-hangzhou") // Region ID
                //.httpClient(httpClient) // Specify the HTTP client. If omitted, the default Apache HttpClient is used.
                .credentialsProvider(provider)
                //.serviceConfiguration(Configuration.create()) // Service-level configuration
                // Override client-level configurations, such as the endpoint and HTTP request parameters.
                .overrideConfiguration(
                        ClientOverrideConfiguration.create()
                                  // Set the endpoint. For a list of endpoints, see https://api.aliyun.com/product/BssOpenApi
                                .setEndpointOverride("business.aliyuncs.com")
                        //.setConnectTimeout(Duration.ofSeconds(30))
                )
                .build();

        // Configure the API request parameters.
        ModifyInstanceRequest.Parameter parameter0 = ModifyInstanceRequest.Parameter.builder()
                .value("cfw_spec")
                .build();
        ModifyInstanceRequest modifyInstanceRequest = ModifyInstanceRequest.builder()
                .productCode("cfw")
                .subscriptionType("Subscription")
                .modifyType("Upgrade")
                .parameter(java.util.Arrays.asList(
                    parameter0
                ))
                // Override request-level configurations, such as HTTP request parameters.
                // .requestConfiguration(RequestConfiguration.create().setHttpHeaders(new HttpHeaders()))
                .build();

        // Call the API asynchronously.
        CompletableFuture response = client.modifyInstance(modifyInstanceRequest);
        // Get the response synchronously.
        ModifyInstanceResponse resp = response.get();
        System.out.println(new Gson().toJson(resp));
        // Process the response asynchronously.
        /*response.thenAccept(resp -> {
            System.out.println(new Gson().toJson(resp));
        }).exceptionally(throwable -> { // Handle exceptions.
            System.out.println(throwable.getMessage());
            return null;
        });*/

        // Close the client.
        client.close();
    }

}

Sample success response

{
  "Message": "Successful!",
  "RequestId": "3EC4C157-46E3-5341-82B0-************",
  "Data": {
    "OrderId": 22165938810****,
    "HostId": "cn****"
  },
  "Code": "Success",
  "Success": true
}

Instance renewal

Call RenewInstance to renew the instance.

Debugging

You can run this API directly in OpenAPI Explorer without having to calculate a signature. Upon a successful call, OpenAPI Explorer automatically generates an SDK code sample.

Parameters

Response parameters

Example

Here is a code sample for a 6-month renewal.

Example request

// This file is auto-generated. Do not edit.
package demo;

import com.aliyun.auth.credentials.Credential;
import com.aliyun.auth.credentials.provider.StaticCredentialProvider;
import com.aliyun.core.http.HttpClient;
import com.aliyun.core.http.HttpMethod;
import com.aliyun.core.http.ProxyOptions;
import com.aliyun.httpcomponent.httpclient.ApacheAsyncHttpClientBuilder;
import com.aliyun.sdk.service.bssopenapi20171214.models.*;
import com.aliyun.sdk.service.bssopenapi20171214.*;
import com.google.gson.Gson;
import darabonba.core.RequestConfiguration;
import darabonba.core.client.ClientOverrideConfiguration;
import darabonba.core.utils.CommonUtil;
import darabonba.core.TeaPair;

//import javax.net.ssl.KeyManager;
//import javax.net.ssl.X509TrustManager;
import java.net.InetSocketAddress;
import java.time.Duration;
import java.util.*;
import java.util.concurrent.CompletableFuture;
import java.io.*;

public class RenewInstance {
    public static void main(String[] args) throws Exception {

        // HttpClient Configuration
        /*HttpClient httpClient = new ApacheAsyncHttpClientBuilder()
                .connectionTimeout(Duration.ofSeconds(10)) // Connection timeout (default: 10s).
                .responseTimeout(Duration.ofSeconds(10)) // Response timeout (default: 20s).
                .maxConnections(128) // Connection pool size.
                .maxIdleTimeOut(Duration.ofSeconds(50)) // Idle connection timeout (default: 30s).
                // Configure a proxy.
                .proxy(new ProxyOptions(ProxyOptions.Type.HTTP, new InetSocketAddress("<your-proxy-hostname>", 9001))
                        .setCredentials("<your-proxy-username>", "<your-proxy-password>"))
                // For HTTPS, configure a certificate or ignore certificate validation.
                .x509TrustManagers(new X509TrustManager[]{})
                .keyManagers(new KeyManager[]{})
                .ignoreSSL(false)
                .build();*/

        // Configure authentication credentials.
        StaticCredentialProvider provider = StaticCredentialProvider.create(Credential.builder()
                // Ensure the ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variables are set.
                .accessKeyId(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"))
                .accessKeySecret(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"))
                //.securityToken(System.getenv("ALIBABA_CLOUD_SECURITY_TOKEN")) // Use an STS token.
                .build());

        // Configure the client.
        AsyncClient client = AsyncClient.builder()
                .region("cn-hangzhou") // region ID
                //.httpClient(httpClient) // Specify the HTTP client. Defaults to Apache HttpClient.
                .credentialsProvider(provider)
                //.serviceConfiguration(Configuration.create()) // Service-level configuration
                // Override client-level settings, such as endpoint and HTTP parameters.
                .overrideConfiguration(
                        ClientOverrideConfiguration.create()
                                  // For endpoints, see https://api.aliyun.com/product/BssOpenApi
                                .setEndpointOverride("business.aliyuncs.com")
                        //.setConnectTimeout(Duration.ofSeconds(30))
                )
                .build();

        // Set API request parameters.
        RenewInstanceRequest renewInstanceRequest = RenewInstanceRequest.builder()
                .productCode("cfw")
                .instanceId("********")
                .renewPeriod(6)
                // Override request-level settings, such as HTTP headers.
                // .requestConfiguration(RequestConfiguration.create().setHttpHeaders(new HttpHeaders()))
                .build();

        // Call the API asynchronously.
        CompletableFuture<RenewInstanceResponse> response = client.renewInstance(renewInstanceRequest);
        // Fetch the response synchronously.
        RenewInstanceResponse resp = response.get();
        System.out.println(new Gson().toJson(resp));
        // Process the response asynchronously.
        /*response.thenAccept(resp -> {
            System.out.println(new Gson().toJson(resp));
        }).exceptionally(throwable -> { // Handle exceptions.
            System.out.println(throwable.getMessage());
            return null;
        });*/

        // Close the client.
        client.close();
    }

}

Successful response

{
  "Message": "Successful!",
  "RequestId": "E15FB71F-7FF8-5272-80B1-*************",
  "Data": {
    "OrderId": 22167752456****
  },
  "Code": "Success",
  "Success": true
}