全部产品
Search
文档中心

全球加速:CreateBasicAccelerateIp - 为基础型全球加速实例创建加速IP

更新时间:Jul 31, 2024

调用CreateBasicAccelerateIp接口为基础型全球加速实例创建加速IP。

接口说明

  • CreateBasicAccelerateIp 接口属于异步接口,即系统会先返回一个请求 ID,但基础型全球加速实例加速 IP 未创建完成,系统后台的创建任务仍在进行。您可以调用 GetBasicAccelerateIp 查询加速 IP 的状态:
    • 当不返回状态信息时,表示加速 IP 正在创建中,在该状态下,您只能执行查询操作,不能执行其他操作。
    • 当加速 IP 处于 active 状态时,表示加速 IP 创建完成。
  • CreateBasicAccelerateIp 接口不支持在同一个基础型全球加速实例内并发创建加速 IP。

调试

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

授权信息

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

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

请求参数

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

全球加速所在的地域 ID,仅取值cn-hangzhou

cn-hangzhou
ClientTokenstring

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

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

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
123e4567-e89b-12d3-a456-426655440000
AcceleratorIdstring

基础型全球加速实例 ID。

ga-bp17frjjh0udz4qz****
IpSetIdstring

基础型全球加速实例的加速地域实例 ID。

您可以调用 GetBasicAccelerator 查询加速地域实例 ID。

ips-bp11r5jb8ogp122xl****

返回参数

名称类型描述示例值
object

返回参数列表。

RequestIdstring

请求 ID。

04F0F334-1335-436C-A1D7-6C044FE73368
AcceleratorIdstring

基础型全球加速实例 ID。

ga-bp17frjjh0udz4qz****
IpSetIdstring

基础型全球加速实例的加速地域实例 ID。

ips-bp11r5jb8ogp122xl****
AccelerateIpIdstring

基础型全球加速实例的加速 IP 实例 ID。

gaip-bp1****
AccelerateIpAddressstring

基础型全球加速实例的加速 IP。

116.132.XX.XX
Statestring

加速 IP 的状态。

说明 该参数当前无实际意义,仅返回为空。
null

示例

正常返回示例

JSON格式

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "AcceleratorId": "ga-bp17frjjh0udz4qz****",
  "IpSetId": "ips-bp11r5jb8ogp122xl****",
  "AccelerateIpId": "gaip-bp1****",
  "AccelerateIpAddress": "116.132.XX.XX",
  "State": "null"
}

错误码

HTTP status code错误码错误信息描述
400NotExist.AcceleratorThe accelerated instance does not exist.加速实例不存在。
400StateError.Acceleratoraccelerator state configuring is illegal加速实例状态非法。
400NotExist.IpSetThe IpSet does not exist.IpSet不存在。
400NotActive.IpSetThe state of IpSet is not active.IpSet状态非稳态

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

变更历史

变更时间变更内容概要操作
2023-04-20OpenAPI 错误码发生变更查看变更详情