云防火墙售卖功能API最佳实践

背景信息

阿里云交易和账单管理API是一套通用的管理阿里云资源的接口，可以用于查询服务价格、管理实例、获取账单信息等。关于阿里云交易和账单管理API支持的所有接口，请参见API概览。

您可以调用阿里云交易和账单管理API提供的接口，查询、创建、变更、续费云防火墙实例。关于该接口的调用方式，请参见请求结构。

查询实例

调用QueryAvailableInstances查询实例资源。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

响应参数

Data

InstanceList

示例

请求示例

import com.aliyuncs.DefaultAcsClient;
import com.aliyuncs.IAcsClient;
import com.aliyuncs.exceptions.ClientException;
import com.aliyuncs.exceptions.ServerException;
import com.aliyuncs.profile.DefaultProfile;
import com.google.gson.Gson;
import java.util.*;
import com.aliyuncs.bssopenapi.model.v20171214.*;
/*
pom.xml
<dependency>
  <groupId>com.aliyun</groupId>
  <artifactId>aliyun-java-sdk-core</artifactId>
  <version>4.6.0</version>
</dependency>
*/

public class QueryAvailableInstances {

    public static void main(String[] args) {

        DefaultProfile profile = DefaultProfile.getProfile("cn-hangzhou", "<your-access-key-id>"<YOUR-ACCESS-KEY-ID>secret>");
        /** use STS Token
        DefaultProfile profile = DefaultProfile.getProfile(
            "<your-region-id>",      <YOUR-REGION-ID>on ID.
            "<your-access-key-id>",       // The AccessKey ID of the RAM account.
            "<your-access-key-secret>",<YOUR-ACCESS-KEY-SECRET>et of the RAM account
            "<your-sts-token>");        <YOUR-STS-TOKEN>       **/

        IAcsClient client = new DefaultAcsClient(profile);


        QueryAvailableInstancesRequest request = new QueryAvailableInstancesRequest();
        request.setProductCode("vipcloudfw");

        try {
            QueryAvailableInstancesResponse response = client.getAcsResponse(request);
            System.out.println(new Gson().toJson(response));
        } catch (ServerException e) {
            e.printStackTrace();
        } catch (ClientException e) {
            System.out.println("ErrCode:" + e.getErrCode());
            System.out.println("ErrMsg:" + e.getErrMsg());
            System.out.println("RequestId:" + e.getRequestId());
        }

    }
}

正常返回示例

{
  "RequestId": "FDE58AA9-37C8-5001-948B-82DE61353864",
  "Message": "Successful!",
  "Data": {
    "TotalCount": 1,
    "PageNum": 1,
    "PageSize": 20,
    "InstanceList": [
      {
        "Status": "Normal",
        "SubscriptionType": "Subscription",
        "OwnerId": 19xxxxxxxxx6359163,
        "EndTime": "2023-06-21T16:00:00Z",
        "ProductCode": "vipcloudfw",
        "InstanceID": "vipcloudfw-cn-pe333nx****",
        "CreateTime": "2021-12-21T05:17:32Z",
        "ProductType": "vipcloudfw",
        "RenewalDurationUnit": "M",
        "Seller": "2****",
        "SubStatus": "Normal",
        "RenewStatus": "ManualRenewal"
      }
    ]
  },
  "Code": "Success",
  "Success": true
}

创建实例

调用CreateInstance创建一个实例资源，调用接口会自动创建一个新购实例资源的订单，并自动支付。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

Parameter

返回参数

示例

下面代码创建了预付费中国站云防火墙，使用手动续费，且预付费用1个月。

请求示例

import com.aliyuncs.CommonRequest;
import com.aliyuncs.CommonResponse;
import com.aliyuncs.DefaultAcsClient;
import com.aliyuncs.IAcsClient;
import com.aliyuncs.exceptions.ClientException;
import com.aliyuncs.exceptions.ServerException;
import com.aliyuncs.http.MethodType;
import com.aliyuncs.profile.DefaultProfile;
/*
pom.xml
<dependency>
  <groupId>com.aliyun</groupId>
  <artifactId>aliyun-java-sdk-core</artifactId>
  <version>4.6.0</version>
</dependency>
*/

public class CreateInstance {
    public static void main(String[] args) {

        DefaultProfile profile = DefaultProfile.getProfile("cn-hangzhou", "<your-access-key-id><YOUR-ACCESS-KEY-ID>-secret>");
        /** use STS Token
        DefaultProfile profile = DefaultProfile.getProfile(
            "<your-region-id>",     <YOUR-REGION-ID>ion ID.
            "<your-access-key-id>",       // The AccessKey ID of the RAM account.
            "<your-access-key-secret>"<YOUR-ACCESS-KEY-SECRET>ret of the RAM account.
            "<your-sts-token>");       <YOUR-STS-TOKEN>
        **/

        IAcsClient client = new DefaultAcsClient(profile);

        CommonRequest request = new CommonRequest();

        request.setSysMethod(MethodType.POST);
        request.setSysDomain("business.aliyuncs.com");
        request.setSysVersion("2017-12-14");
        request.setSysAction("CreateInstance");
        request.putQueryParameter("RenewalStatus", "ManualRenewal");
        request.putQueryParameter("ProductCode", "vipcloudfw");
        request.putQueryParameter("Parameter.1.Code", "CfwAccount");
        request.putQueryParameter("Parameter.1.Value", "true");
        request.putQueryParameter("Parameter.2.Code", "CfwAccount");
        request.putQueryParameter("Parameter.2.Value", "true");
        request.putQueryParameter("Parameter.3.Code", "VpcBandwidth");
        request.putQueryParameter("Parameter.3.Value", "1000");//VPC流量处理能力为1000 Mbps。
        request.putQueryParameter("Parameter.4.Code", "AclExtension");
        request.putQueryParameter("Parameter.4.Value", "1000");//访问控制全局扩展为1000条。
        request.putQueryParameter("Parameter.5.Code", "CfwAccountNum");
        request.putQueryParameter("Parameter.5.Value", "1");//多账号管控数为1。
        request.putQueryParameter("Parameter.6.Code", "FwVpcNumber");
        request.putQueryParameter("Parameter.6.Value", "10");//可防护的VPC数为10个。
        request.putQueryParameter("Parameter.7.Code", "IpNumber");
        request.putQueryParameter("Parameter.7.Value", "400");//可防护公网IP数为400。
        request.putQueryParameter("Parameter.8.Code", "CfwLogStorage");
        request.putQueryParameter("Parameter.8.Value", "10000");//日志存储容量为10000 GB。
        request.putQueryParameter("Parameter.9.Code", "CfwLog");
        request.putQueryParameter("Parameter.9.Value", "true");//开通日志分析功能。
        request.putQueryParameter("Parameter.10.Code", "BandWidth");
        request.putQueryParameter("Parameter.10.Value", "200");//公网流量处理能力为200 Mbps。
        request.putQueryParameter("Parameter.11.Code", "Spec");
        request.putQueryParameter("Parameter.11.Value", "4");//旗舰版。
        request.putQueryParameter("SubscriptionType", "Subscription");//预付费类型。
        request.putQueryParameter("Period", "1");//1个月。
        try {
            CommonResponse response = client.getCommonResponse(request);
            System.out.println(response.getData());
        } catch (ServerException e) {
            e.printStackTrace();
        } catch (ClientException e) {
            e.printStackTrace();
        }
    }
}

正常返回示例

云防火墙创建成功会返回实例ID（InstanceId），实例ID在后续变配和续费中将用到。

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

变更实例

调用ModifyInstance对实例资源配置进行变更。调用接口会创建一个变配实例资源的订单，并自动支付。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

Parameter

响应参数

示例

下面代码为您实现将公网流量处理能力从200 Mbps升级到500 Mbps。

请求示例

import com.aliyuncs.CommonRequest;
import com.aliyuncs.CommonResponse;
import com.aliyuncs.DefaultAcsClient;
import com.aliyuncs.IAcsClient;
import com.aliyuncs.exceptions.ClientException;
import com.aliyuncs.exceptions.ServerException;
import com.aliyuncs.http.MethodType;
import com.aliyuncs.profile.DefaultProfile;
/*
pom.xml
<dependency>
  <groupId>com.aliyun</groupId>
  <artifactId>aliyun-java-sdk-core</artifactId>
  <version>4.6.0</version>
</dependency>
*/

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

        DefaultProfile profile = DefaultProfile.getProfile("cn-hangzhou", "<your-access-key-id><YOUR-ACCESS-KEY-ID>-sec<YOUR-ACCESS-KEY-SECRET>TS Token
        DefaultProfile profile = DefaultProfile.getProfile(
            "<your-region-id>",    <YOUR-REGION-ID>>ion ID
            "<your-access-key-id>",       // The AccessKey ID of the RAM account
            "<your-access-key-secret><YOUR-ACCESS-KEY-SECRET>cret of the RAM account
            "<your-sts-token>");      <YOUR-STS-TOKEN>>       **/

        IAcsClient client = new DefaultAcsClient(profile);

        CommonRequest request = new CommonRequest();

        request.setSysMethod(MethodType.POST);
        request.setSysDomain("business.aliyuncs.com");
        request.setSysVersion("2017-12-14");
        request.setSysAction("ModifyInstance");
        request.putQueryParameter("ProductCode", "vipcloudfw");
        request.putQueryParameter("SubscriptionType", "Subscription");
        request.putQueryParameter("ModifyType", "Upgrade");
        request.putQueryParameter("InstanceId", "vipcloudfw-cn-pe333nx****");
        request.putQueryParameter("Parameter.1.Code", "BandWidth");
        request.putQueryParameter("Parameter.1.Value", "500");
        try {
            CommonResponse response = client.getCommonResponse(request);
            System.out.println(response.getData());
        } catch (ServerException e) {
            e.printStackTrace();
        } catch (ClientException e) {
            e.printStackTrace();
        }
    }
}

正常返回示例

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

实例续费

调用RenewInstance对相关实例进行续费。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

响应参数

示例

以下是实现续费6个月的代码示例。

请求示例

import com.aliyuncs.DefaultAcsClient;
import com.aliyuncs.IAcsClient;
import com.aliyuncs.exceptions.ClientException;
import com.aliyuncs.exceptions.ServerException;
import com.aliyuncs.profile.DefaultProfile;
import com.google.gson.Gson;
import java.util.*;
import com.aliyuncs.bssopenapi.model.v20171214.*;
/*
pom.xml
<dependency>
  <groupId>com.aliyun</groupId>
  <artifactId>aliyun-java-sdk-core</artifactId>
  <version>4.6.0</version>
</dependency>
*/

public class RenewInstance {

    public static void main(String[] args) {

        DefaultProfile profile = DefaultProfile.getProfile("cn-hangzhou", "<your-access-key-id>"<YOUR-ACCESS-KEY-ID>secret>");
        /** use STS Token
        DefaultProfile profile = DefaultProfile.getProfile(
            "<your-region-id>",      <YOUR-REGION-ID>on ID.
            "<your-access-key-id>",       // The AccessKey ID of the RAM account.
            "<your-access-key-secret>",<YOUR-ACCESS-KEY-SECRET>et of the RAM account.
            "<your-sts-token>");        <YOUR-STS-TOKEN>       **/

        IAcsClient client = new DefaultAcsClient(profile);


        RenewInstanceRequest request = new RenewInstanceRequest();
        request.setProductCode("vipcloudfw");
        request.setInstanceId("vipcloudfw-cn-pe333nx****");
        request.setRenewPeriod(6);

        try {
            RenewInstanceResponse response = client.getAcsResponse(request);
            System.out.println(new Gson().toJson(response));
        } catch (ServerException e) {
            e.printStackTrace();
        } catch (ClientException e) {
            System.out.println("ErrCode:" + e.getErrCode());
            System.out.println("ErrMsg:" + e.getErrMsg());
            System.out.println("RequestId:" + e.getRequestId());
        }

    }
}

正常返回示例

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