文档

CreateBasicAccelerator - 创建基础型全球加速实例

更新时间:

基础型全球加速实例依托阿里云优质的全球互联网带宽与高品质传输网络,为用户提供点到点的加速体验。基础型全球加速实例主要用于三层(IP协议)网络加速。您可以通过调用CreateBasicAccelerator接口创建一个基础型全球加速实例。

接口说明

CreateBasicAccelerator 接口属于异步接口,即系统会先返回一个基础型全球加速实例 ID,但基础型全球加速实例并未创建完成,系统后台的创建任务仍在进行。您可以调用 GetBasicAcceleratorListBasicAccelerators 查询基础型全球加速实例的状态:

  • 当基础型全球加速实例处于 init 状态时,表示基础型全球加速实例正在创建中,在该状态下,您只能执行查询操作,不能执行其他操作。
  • 当基础型全球加速实例处于 active 状态时,表示基础型全球加速实例创建完成。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ga:CreateBasicAcceleratorWrite
  • BasicAccelerator
    acs:ga:{#regionId}:{#accountId}:ga/*

请求参数

名称类型必填描述示例值
RegionIdstring

基础型全球加速实例所属的地域 ID,仅取值:cn-hangzhou

cn-hangzhou
ClientTokenstring

客户端 Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
123e4567****
Durationinteger

购买时长。

  • PricingCycle 取值 Month 时,Duration 取值范围为 1~9

  • PricingCycle 取值 Year 时,Duration 取值范围为 1~3

1
PricingCyclestring

计费周期。取值:

  • Month:按月计费。

  • Year:按年计费。

Month
BandwidthBillingTypestring

带宽计费方式。取值:

  • BandwidthPackage:按带宽包计费。
  • CDT:按流量计费并由云数据传输(Cloud DataTransfer,简称 CDT)统一结算。
  • CDT95:按 95 计费并由 CDT 统一结算。该带宽计费方式仅白名单用户可用。
CDT
AutoPayboolean

是否自动付费,取值:

  • false(默认值):不开启自动付费,生成订单后需要到订单中心完成支付。

  • true:开启自动付费,自动支付订单。

false
AutoUseCouponstring

是否使用优惠券自动支付账单。取值:

  • true:使用。

  • false(默认值):不使用。

说明 AutoPaytrue 时,该项才生效。
false
PromotionOptionNostring

优惠券号码。

说明 仅国际站涉及该参数。
50003298014****
AutoRenewboolean

是否开启自动续费。

  • true:是。

  • false(默认值):否。

false
AutoRenewDurationinteger

自动续费时长。单位:月。

取值范围:1~12。默认值:1

说明 AutoRenew 的为 true 时,该项才生效。
1
ResourceGroupIdstring

基础型全球加速实例所属资源组 ID。

rg-acfmxshhcsn****
ChargeTypestring

付费类型。取值:

  • PREPAY(默认值):代表预付费,即包年包月方式付费。
  • POSTPAY:代表后付费,即按使用时长方式付费。
PREPAY
DryRunboolean

是否只预检此次请求。取值:

  • true:发送检查请求,不会创建资源。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation
  • false(默认值):发送正常请求,通过检查后返回 HTTP 2xx 状态码并直接进行操作。
false
Tagobject []

基础型全球加速实例的标签。

Keystring

基础型全球加速实例的标签键。一旦输入该值,则不允许为空字符串。

最多支持 64 个字符,不能以aliyunacs:开头,不能包含http://或者https://

您最多可输入 20 个标签键。

tag-key
Valuestring

基础型全球加速实例的标签值。一旦输入该值,不可以为空字符串。

最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

您最多可输入 20 个标签值。

tag-value

返回参数

名称类型描述示例值
object

返回信息列表。

RequestIdstring

请求 ID。

F591955F-5CB5-4CCE-A75D-17CF2085CE22
OrderIdstring

订单 ID。

当 ChargeType(付费类型)取值为 PREPAY(预付费)时,返回该参数。

如果 AutoPay 取值为 false,即未开启自动支付账单时,请前往订单中心 完成支付。

2082574365
AcceleratorIdstring

基础型全球加速实例 ID。

ga-bp17frjjh0udz4qz****

示例

正常返回示例

JSON格式

{
  "RequestId": "F591955F-5CB5-4CCE-A75D-17CF2085CE22",
  "OrderId": "2082574365",
  "AcceleratorId": "ga-bp17frjjh0udz4qz****"
}

错误码

HTTP status code错误码错误信息描述
500UnknownErrorAn error occurred while processing your request. Please try again. If the error persists, please submit a ticket.处理请求时出现错误,请稍后重试。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-04-20OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:500
2023-04-10OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:500
入参OpenAPI 入参发生变更
    新增入参:Tag
  • 本页导读 (1)
文档反馈