调用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:CreateBasicAccelerateIp | create |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 全球加速所在的地域 ID,仅取值cn-hangzhou。 | cn-hangzhou |
ClientToken | string | 否 | 客户端 Token,用于保证请求的幂等性。 从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。 说明
若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
| 123e4567-e89b-12d3-a456-426655440000 |
AcceleratorId | string | 是 | 基础型全球加速实例 ID。 | ga-bp17frjjh0udz4qz**** |
IpSetId | string | 是 | 基础型全球加速实例的加速地域实例 ID。 您可以调用 GetBasicAccelerator 查询加速地域实例 ID。 | ips-bp11r5jb8ogp122xl**** |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | NotExist.Accelerator | The accelerated instance does not exist. | 加速实例不存在。 |
400 | StateError.Accelerator | accelerator state configuring is illegal | 加速实例状态非法。 |
400 | NotExist.IpSet | The IpSet does not exist. | IpSet不存在。 |
400 | NotActive.IpSet | The state of IpSet is not active. | IpSet状态非稳态 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-04-20 | OpenAPI 错误码发生变更 | 查看变更详情 |