AI 助理
备案控制台
文档
输入文档关键字查找
首页 云解析DNS 全局流量管理 全局流量管理3.0 开发参考 通过API接口购买实例

通过API接口购买实例

更新时间：
产品详情
我的收藏

本文主要介绍通过API接口调用方式进行全局流量管理产品实例的创建。

前提条件

实例创建、续费使用 阿里云交易和账单管理API，因此调用的时候需要遵循 阿里云交易和账单管理API 相关规范。

实例创建服务

具体参考：实例创建服务。

SDK

  • Maven依赖：

<dependencies>
    <dependency>
        <groupId>com.aliyun</groupId>
        <artifactId>aliyun-java-sdk-bssopenapi</artifactId>
        <version>1.6.6</version>
    </dependency>

    <dependency>
        <groupId>com.aliyun</groupId>
        <artifactId>aliyun-java-sdk-core</artifactId>
        <version>4.4.6</version>
    </dependency>
</dependencies>

其他语言参考：SDK列表。

重要

中国站RegionId固定使用为cn-hangzhou、国际站RegionId固定使用为ap-southeast-1。

创建全局流量管理实例

描述：通过 CreateInstance 进行全局流量管理实例创建。

调用接口名称：CreateInstance

接口参考文档：实例创建服务。

参数说明

名称

类型

是否必填

说明

描述

ProductCode

String

是

产品代码

产品code，取值：dns

ProductType

String

是

产品类型

商品code，取值：

  • dns_gtm_public_cn：适用于中国站用户

  • dns_gtm_public_intl：适用于国际站用户

SubscriptionType

String

是

付费类型

付费类型，取值：

  • Subscription：预付费，当前只支持预付费模式。

Period

Integer

是

预付费周期

当创建预付费实例时，必须设置，单位为月，按年付费产品请输入12的整数倍。举例：

  • 1：购买周期为1个月；

  • 6：购买周期为半年；

  • 12：购买周期为1年；

  • 36：购买周期为3年；

RenewalStatus

String

否

自动续费状态

  • AutoRenewal：自动续费。

  • ManualRenewal：手动续费（默认值）。

RenewPeriod

Integer

否

自动续费周期， 单位为月。

当设置RenewalStatus为AutoRenewal时，必须设置。举例：

  • 1：自动续费周期为1个月；

  • 6：自动续费周期为半年；

  • 12：自动续费周期为1年；

Parameter.1.Value

String

是

订购的套餐版本值

  • standard：标准版

  • ultimate： 旗舰版

Parameter.1.Code

String

是

套餐版本

PackageEdition

Parameter.2.Value

String

是

额外订购的探测任务包数量

实例版本中默认已经含有100个探测任务，一般无需额外购买，每个探测任务包含100个探测任务。举例：

  • 0：默认值；

  • 100：额外购买了100个探测任务，加上实例版本默认含有的100个，总计200个探测任务。

说明

最小值：0，步长：100，最大值：100000。

Parameter.2.Code

String

是

探测任务包

HealthcheckTaskCount

Parameter.3.Value

String

是

国内短信通知包订购数量

实例版本中默认已经含有1000条短消息，一般无需额外购买，每个短消息包含1000条短消息。举例：

  • 0，默认值

  • 1000，额外购买了1000条短消息，加上实例版本默认含有的1000条，总计2000条短消息。

说明

最小值：0，步长：1000，最大值：100000。

Parameter.3.Code

String

是

国内短信通知包

SmsNotificationCount

Parameter.4.Value

String

是

订购的套餐版本值

目前控制塔有新老版本实例同时售卖，建议购买全局流量管理3.0，产品能力更丰富。取值：

  • subscription：老版本实例

  • subscription3.0： 全局流量管理3.0实例

Parameter.4.Code

String

是

实例version

PaymentMode

代码Demo

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

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>使用AK&amp;SK初始化账号Client</p>
     * @return Client
     * 
     * @throws Exception
     */
    public static com.aliyun.bssopenapi20171214.Client createClient() throws Exception {
        // 工程代码泄露可能会导致 AccessKey 泄露，并威胁账号下所有资源的安全性。以下代码示例仅供参考。
        // 建议使用更安全的 STS 方式，更多鉴权访问方式请参见：https://help.aliyun.com/document_detail/378657.html。
        com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config()
                // 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID。
                .setAccessKeyId(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"))
                // 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。
                .setAccessKeySecret(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
        // Endpoint 请参考 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 {
        java.util.List<String> args = java.util.Arrays.asList(args_);
        com.aliyun.bssopenapi20171214.Client client = Sample.createClient();
        com.aliyun.bssopenapi20171214.models.CreateInstanceRequest.CreateInstanceRequestParameter parameter0 = new com.aliyun.bssopenapi20171214.models.CreateInstanceRequest.CreateInstanceRequestParameter()
                .setValue("standard")
                .setCode("PackageEdition");
        com.aliyun.bssopenapi20171214.models.CreateInstanceRequest.CreateInstanceRequestParameter parameter1 = new com.aliyun.bssopenapi20171214.models.CreateInstanceRequest.CreateInstanceRequestParameter()
                .setValue("100")
                .setCode("HealthcheckTaskCount");
        com.aliyun.bssopenapi20171214.models.CreateInstanceRequest.CreateInstanceRequestParameter parameter2 = new com.aliyun.bssopenapi20171214.models.CreateInstanceRequest.CreateInstanceRequestParameter()
                .setValue("1000")
                .setCode("SmsNotificationCount");
        com.aliyun.bssopenapi20171214.models.CreateInstanceRequest.CreateInstanceRequestParameter parameter3 = new com.aliyun.bssopenapi20171214.models.CreateInstanceRequest.CreateInstanceRequestParameter()
                .setValue("subscription3.0")
                .setCode("PaymentMode");
        com.aliyun.bssopenapi20171214.models.CreateInstanceRequest createInstanceRequest = new com.aliyun.bssopenapi20171214.models.CreateInstanceRequest()
                .setProductCode("dns")
                .setProductType("dns_gtm_public_cn")
                .setSubscriptionType("Subscription")
                .setPeriod(12)
                .setRenewalStatus("AutoRenewal")
                .setParameter(java.util.Arrays.asList(
                    parameter0,
                    parameter1,
                    parameter2,
                    parameter3
                ))
                .setRenewPeriod(12);
        com.aliyun.teautil.models.RuntimeOptions runtime = new com.aliyun.teautil.models.RuntimeOptions();
        try {
            // 复制代码运行请自行打印 API 的返回值
            client.createInstanceWithOptions(createInstanceRequest, runtime);
        } catch (TeaException error) {
            // 此处仅做打印展示，请谨慎对待异常处理，在工程项目中切勿直接忽略异常。
            // 错误 message
            System.out.println(error.getMessage());
            // 诊断地址
            System.out.println(error.getData().get("Recommend"));
            com.aliyun.teautil.Common.assertAsString(error.message);
        } catch (Exception _error) {
            TeaException error = new TeaException(_error.getMessage(), _error);
            // 此处仅做打印展示，请谨慎对待异常处理，在工程项目中切勿直接忽略异常。
            // 错误 message
            System.out.println(error.getMessage());
            // 诊断地址
            System.out.println(error.getData().get("Recommend"));
            com.aliyun.teautil.Common.assertAsString(error.message);
        }        
    }
}
# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import os
import sys

from typing import List

from alibabacloud_bssopenapi20171214.client import Client as BssOpenApi20171214Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_bssopenapi20171214 import models as bss_open_api_20171214_models
from alibabacloud_tea_util import models as util_models
from alibabacloud_tea_util.client import Client as UtilClient


class Sample:
    def __init__(self):
        pass

    @staticmethod
    def create_client() -> BssOpenApi20171214Client:
        """
        使用AK&SK初始化账号Client
        @return: Client
        @throws Exception
        """
        # 工程代码泄露可能会导致 AccessKey 泄露，并威胁账号下所有资源的安全性。以下代码示例仅供参考。
        # 建议使用更安全的 STS 方式，更多鉴权访问方式请参见：https://help.aliyun.com/document_detail/378659.html。
        config = open_api_models.Config(
            # 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID。,
            access_key_id=os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID'],
            # 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。,
            access_key_secret=os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET']
        )
        # Endpoint 请参考 https://api.aliyun.com/product/BssOpenApi
        config.endpoint = f'business.aliyuncs.com'
        return BssOpenApi20171214Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        parameter_0 = bss_open_api_20171214_models.CreateInstanceRequestParameter(
            value='standard',
            code='PackageEdition'
        )
        parameter_1 = bss_open_api_20171214_models.CreateInstanceRequestParameter(
            value='100',
            code='HealthcheckTaskCount'
        )
        parameter_2 = bss_open_api_20171214_models.CreateInstanceRequestParameter(
            value='1000',
            code='SmsNotificationCount'
        )
        parameter_3 = bss_open_api_20171214_models.CreateInstanceRequestParameter(
            value='subscription3.0',
            code='PaymentMode'
        )
        create_instance_request = bss_open_api_20171214_models.CreateInstanceRequest(
            product_code='dns',
            product_type='dns_gtm_public_cn',
            subscription_type='Subscription',
            period=12,
            renewal_status='AutoRenewal',
            parameter=[
                parameter_0,
                parameter_1,
                parameter_2,
                parameter_3
            ],
            renew_period=12
        )
        runtime = util_models.RuntimeOptions()
        try:
            # 复制代码运行请自行打印 API 的返回值
            client.create_instance_with_options(create_instance_request, runtime)
        except Exception as error:
            # 此处仅做打印展示，请谨慎对待异常处理，在工程项目中切勿直接忽略异常。
            # 错误 message
            print(error.message)
            # 诊断地址
            print(error.data.get("Recommend"))
            UtilClient.assert_as_string(error.message)

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        parameter_0 = bss_open_api_20171214_models.CreateInstanceRequestParameter(
            value='standard',
            code='PackageEdition'
        )
        parameter_1 = bss_open_api_20171214_models.CreateInstanceRequestParameter(
            value='100',
            code='HealthcheckTaskCount'
        )
        parameter_2 = bss_open_api_20171214_models.CreateInstanceRequestParameter(
            value='1000',
            code='SmsNotificationCount'
        )
        parameter_3 = bss_open_api_20171214_models.CreateInstanceRequestParameter(
            value='subscription3.0',
            code='PaymentMode'
        )
        create_instance_request = bss_open_api_20171214_models.CreateInstanceRequest(
            product_code='dns',
            product_type='dns_gtm_public_cn',
            subscription_type='Subscription',
            period=12,
            renewal_status='AutoRenewal',
            parameter=[
                parameter_0,
                parameter_1,
                parameter_2,
                parameter_3
            ],
            renew_period=12
        )
        runtime = util_models.RuntimeOptions()
        try:
            # 复制代码运行请自行打印 API 的返回值
            await client.create_instance_with_options_async(create_instance_request, runtime)
        except Exception as error:
            # 此处仅做打印展示，请谨慎对待异常处理，在工程项目中切勿直接忽略异常。
            # 错误 message
            print(error.message)
            # 诊断地址
            print(error.data.get("Recommend"))
            UtilClient.assert_as_string(error.message)


if __name__ == '__main__':
    Sample.main(sys.argv[1:])
// This file is auto-generated, don't edit it. Thanks.
package main

import (
  "encoding/json"
  "strings"
  "fmt"
  "os"
  bssopenapi20171214  "github.com/alibabacloud-go/bssopenapi-20171214/v5/client"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/v2/client"
  util  "github.com/alibabacloud-go/tea-utils/v2/service"
  "github.com/alibabacloud-go/tea/tea"
)


// Description:
// 
// 使用AK&SK初始化账号Client
// 
// @return Client
// 
// @throws Exception
func CreateClient () (_result *bssopenapi20171214.Client, _err error) {
  // 工程代码泄露可能会导致 AccessKey 泄露，并威胁账号下所有资源的安全性。以下代码示例仅供参考。
  // 建议使用更安全的 STS 方式，更多鉴权访问方式请参见：https://help.aliyun.com/document_detail/378661.html。
  config := &openapi.Config{
    // 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID。
    AccessKeyId: tea.String(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_ID")),
    // 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。
    AccessKeySecret: tea.String(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")),
  }
  // Endpoint 请参考 https://api.aliyun.com/product/BssOpenApi
  config.Endpoint = tea.String("business.aliyuncs.com")
  _result = &bssopenapi20171214.Client{}
  _result, _err = bssopenapi20171214.NewClient(config)
  return _result, _err
}

func _main (args []*string) (_err error) {
  client, _err := CreateClient()
  if _err != nil {
    return _err
  }

  parameter0 := &bssopenapi20171214.CreateInstanceRequestParameter{
    Value: tea.String("standard"),
    Code: tea.String("PackageEdition"),
  }
  parameter1 := &bssopenapi20171214.CreateInstanceRequestParameter{
    Value: tea.String("100"),
    Code: tea.String("HealthcheckTaskCount"),
  }
  parameter2 := &bssopenapi20171214.CreateInstanceRequestParameter{
    Value: tea.String("1000"),
    Code: tea.String("SmsNotificationCount"),
  }
  parameter3 := &bssopenapi20171214.CreateInstanceRequestParameter{
    Value: tea.String("subscription3.0"),
    Code: tea.String("PaymentMode"),
  }
  createInstanceRequest := &bssopenapi20171214.CreateInstanceRequest{
    ProductCode: tea.String("dns"),
    ProductType: tea.String("dns_gtm_public_cn"),
    SubscriptionType: tea.String("Subscription"),
    Period: tea.Int32(12),
    RenewalStatus: tea.String("AutoRenewal"),
    Parameter: []*bssopenapi20171214.CreateInstanceRequestParameter{parameter0, parameter1, parameter2, parameter3},
    RenewPeriod: tea.Int32(12),
  }
  runtime := &util.RuntimeOptions{}
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    // 复制代码运行请自行打印 API 的返回值
    _, _err = client.CreateInstanceWithOptions(createInstanceRequest, runtime)
    if _err != nil {
      return _err
    }

    return nil
  }()

  if tryErr != nil {
    var error = &tea.SDKError{}
    if _t, ok := tryErr.(*tea.SDKError); ok {
      error = _t
    } else {
      error.Message = tea.String(tryErr.Error())
    }
    // 此处仅做打印展示，请谨慎对待异常处理，在工程项目中切勿直接忽略异常。
    // 错误 message
    fmt.Println(tea.StringValue(error.Message))
    // 诊断地址
    var data interface{}
    d := json.NewDecoder(strings.NewReader(tea.StringValue(error.Data)))
    d.Decode(&data)
    if m, ok := data.(map[string]interface{}); ok {
      recommend, _ := m["Recommend"]
      fmt.Println(recommend)
    }
    _, _err = util.AssertAsString(error.Message)
    if _err != nil {
      return _err
    }
  }
  return _err
}


func main() {
  err := _main(tea.StringSlice(os.Args[1:]))
  if err != nil {
    panic(err)
  }
}
上一篇：API参考下一篇：服务支持
文档推荐