调用CreateBasicEndpointGroup接口创建基础型全球加速实例的终端节点组。
接口说明
- CreateBasicEndpointGroup 接口属于异步接口,即系统会先返回一个终端节点组 ID,但终端节点组未创建完成,系统后台的创建任务仍在进行。您可以调用 GetBasicEndpointGroup 查询终端节点组的状态:
- 当终端节点组处于 init 状态时,表示终端节点组正在创建中,在该状态下,您只能执行查询操作,不能执行其他操作。
- 当终端节点组处于 active 状态时,表示终端节点组创建完成。
- CreateBasicEndpointGroup 接口不支持在同一个基础型全球加速实例内并发创建终端节点组。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ga:CreateBasicEndpointGroup | 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**** |
EndpointGroupRegion | string | 是 | 基础型全球加速实例的终端节点组所在的地域 ID。 您可以通过调用 ListAvailableBusiRegions 接口获取地域 ID。 | cn-shanghai |
Name | string | 否 | 基础型全球加速实例的终端节点组的名称。 名称长度为 1~128 个字符,以大小写字母或中文开头,可包含数字、半角句号(.)下划线(_)和短划线(-)。 | group1 |
Description | string | 否 | 基础型全球加速实例的终端节点组描述信息。 描述长度最大 200 字符,不能以 | BasicEndpointGroup |
EndpointType | string | 否 | 终端节点类型。取值:
| ENI |
EndpointAddress | string | 否 | 终端节点的地址。 | eni-bp1a05txelswuj8g**** |
EndpointSubAddress | string | 否 | 终端节点辅助地址。 当加速 IP 绑定到 ECS 辅助私网 IP 地址或 ENI 辅助私网 IP 时,需配置该参数。
| 172.16.XX.XX |
返回参数
示例
正常返回示例
JSON
格式
{
"EndpointGroupId": "epg-bp1dmlohjjz4kqaun****",
"RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | Resource.QuotaFull | The resource quota is exceeded. | 该资源数量已达配额上限 |
400 | NoPermission.EnableHealthCheck | You do not have permission to enable health check. | 该账号没有启用健康检查的权限。 |
400 | NotExist.Accelerator | The accelerated instance does not exist. | 加速实例不存在。 |
400 | StateError.Accelerator | The state of the accelerated instance is invalid. | 加速实例状态非法。 |
400 | NotExist.BusinessRegion | The business region does not exist. | 业务region并不存在 |
400 | NotExist.BasicBandwidthPackage | You must specify the basic bandwidth package. | 缺少基础带宽包 |
400 | Exist.EndpointGroup | The endpoint group already exists. | 终端节点组已存在 |
400 | QuotaExceeded.EndpointGroup | The number of endpoint group exceeds the limit. | 终端节点组数量超过限制额度。 |
400 | EcsCannotBind.BasicEndpoint | The ECS instance has already been associated with another EIP. | 该ECS实例不可被绑定,因为实例已经被其它EIP绑定。 |
400 | InvalidateRegion.BasicAccelerator | The region of the endpoint group and the acceleration region cannot be the same. | 终端节点组地域和加速区域不可以在同一区域。 |
500 | UnknownError | An error occurred while processing your request. Please try again. If the error persists, please submit a ticket. | 处理请求时出现错误,请稍后重试。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-04-20 | OpenAPI 错误码发生变更 | 查看变更详情 |
2023-04-13 | OpenAPI 错误码发生变更 | 查看变更详情 |