CreateBasicEndpoints - 为基础型全球加速实例批量创建终端节点

调用CreateBasicEndpoints接口为基础型全球加速实例批量创建终端节点。

接口说明

  • CreateBasicEndpoints 接口属于异步接口,即系统会先返回一个请求 ID,但终端节点未批量创建完成,系统后台的批量创建任务仍在进行。您可以调用 ListBasicEndpoints 查询终端节点的状态: - 当存在终端节点状态为 init 时,表示终端节点批量创建任务未完成,在该状态下,您只能执行查询操作,不能执行其他操作。 - 当所有终端节点状态为 active 时,表示终端节点已批量创建完成。
  • CreateBasicEndpoints 接口不支持在同一个基础型全球加速实例内并发批量创建终端节点。

调试

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

授权信息

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

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

请求参数

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

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

cn-hangzhou
ClientTokenstring

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

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

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

基础型全球加速实例 ID。

ga-bp17frjjh0udz4qz****
EndpointGroupIdstring

基础型全球加速实例的终端节点组 ID。

epg-bp1dmlohjjz4kqaun****
Endpointsarray<object>

基础型全球加速实例的终端节点列表。

object

基础型全球加速实例的终端节点列表。

Namestring

基础型全球加速实例终端节点的名称。

名称长度为 1~128 个字符,以大小写字母或中文开头,可包含数字、半角句号(.)下划线(_)和短划线(-)。

ep01
EndpointTypestring

终端节点类型。取值:

  • ENI:阿里云弹性网卡。
  • SLB:阿里云 CLB 实例。
  • ECS:阿里云 ECS 实例。
  • NLB:阿里云 NLB 实例。
说明 该参数必填。
ENI
EndpointAddressstring

终端节点的地址。

eni-bp1a05txelswuj8g****
EndpointSubAddressstring

终端节点辅助地址。

当终端节点类型为 ECSENINLB 时,需配置该参数。

  • 当终端节点类型为 ECS 时,EndpointSubAddress 可以为主网卡的辅助私网 IP,为空表示主网卡的主私网 IP。
  • 当终端节点类型为 ENI 时,EndpointSubAddress 可以为辅助网卡的辅助私网 IP,为空表示辅助网卡的主私网 IP。
  • 当终端节点类型为 NLB 时,该参数必填,EndpointSubAddress 为 NLB 后端服务器的主私网 IP。
172.16.XX.XX
EndpointSubAddressTypestring

终端节点辅助地址的类型。取值:

  • primary:终端节点辅助地址的类型为主私网 IP。
  • secondary:终端节点辅助地址的类型为辅助私网 IP。

当终端节点类型为 ECSENINLB 时,需配置该参数。其中,终端节点类型为 NLB 时,仅支持 primary 类型。

primary
EndpointZoneIdstring

终端节点所在可用区 ID。

目前,仅当终端节点类型为 NLB 时,需要输入该参数。

cn-hangzhou-g

返回参数

名称类型描述示例值
object

返回参数列表。

RequestIdstring

请求 ID。

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

基础型全球加速实例的终端节点组 ID。

epg-bp1dmlohjjz4kqaun****
Endpointsarray<object>

基础型全球加速实例的终端节点列表。

object

基础型全球加速实例的终端节点列表。

EndpointIdstring

基础型全球加速实例的终端节点 ID。

ep-bp14sz7ftcwwjgrdm****
EndpointTypestring

终端节点类型。

  • ENI:阿里云弹性网卡。
  • SLB:阿里云 CLB 实例。
  • ECS:阿里云 ECS 实例。
  • NLB:阿里云 NLB 实例。
ENI
EndpointAddressstring

终端节点的地址。

eni-bp1a05txelswuj8g****
EndpointSubAddressstring

终端节点辅助地址。

当终端节点类型为 ECSENINLB 时,返回该参数。

  • 当终端节点类型为 ECS 时,EndpointSubAddress 为主网卡的辅助私网 IP 或主网卡的主私网 IP。
  • 当终端节点类型为 ENI 时,EndpointSubAddress 为辅助网卡的辅助私网 IP 或辅助网卡的主私网 IP。
  • 当终端节点类型为 NLB 时,EndpointSubAddress 为 NLB 后端服务器的主私网 IP。
172.16.XX.XX

示例

正常返回示例

JSON格式

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "EndpointGroupId": "epg-bp1dmlohjjz4kqaun****",
  "Endpoints": [
    {
      "EndpointId": "ep-bp14sz7ftcwwjgrdm****",
      "EndpointType": "ENI",
      "EndpointAddress": "eni-bp1a05txelswuj8g****",
      "EndpointSubAddress": "172.16.XX.XX"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400NotExist.AcceleratorThe accelerated instance does not exist.加速实例不存在。
400NotFound.ENIInstanceThe ENI instance is not found.终端节点组所属区域中不存在该eni实例。
400Invalidate.SlbAddressTypeThe SLB instance must be internal-facing.SLB实例类型必须为私网。

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

变更历史

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