API概览

更新时间:
复制 MD 格式

API标准及多语言预置SDK

本产品(eflo/2022-05-30)的OpenAPI采用RPC签名风格。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(147535001692),在专家指导下进行签名对接。

在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

自定义签名场景

若您的业务场景有特殊需求,需通过自签名方式对接 API,建议优先咨询我们的技术支持团队(服务钉钉群:147535001692),获取专业指导以确保高效接入。

账号与安全准备

阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露,所有相关资源都将面临未经授权访问的风险。为确保安全,建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey,同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下,才使用阿里云账号。

灵骏网段

API

标题

API概述

CreateVpd 创建灵骏网段 创建用户私有的灵骏网段,该网段拥有独立的网络环境。
DeleteVpd 删除灵骏网段 删除某个灵骏网段实例,删除后相关数据丢失且不可恢复。
UpdateVpd 更新灵骏网段 更新灵骏网段实例的部分信息,包括灵骏网段实例的名称。
GetVpd 查询灵骏网段详情 查询某个灵骏网段的详细信息,包括灵骏网段状态,Cidr地址,服务网段,SubnetNC的数量等。
ListVpds 查询灵骏网段 查询一个或多个灵骏网段的详细信息,包括灵骏网段状态,Cidr地址,服务网段,Subnet等。
AssociateVpdCidrBlock 申请VPD附加网段 VPD主网段地址不够分配的时候,可以选择创建额外的附加网段作为VPD主网段的附加网段。
UnAssociateVpdCidrBlock 删除VPD附加网段 可通过此功能对VPD的附加网段进行删除。
跨账号授权 跨账号授权
CreateVpdGrantRule 创建灵骏网段跨账号授权信息 用户可通过此API,将灵骏网段实例对目标账号的灵骏HUB实例授权。授权后,目标账号即可用被授权的灵骏HUB实例关联到您的灵骏网段。
DeleteVpdGrantRule 删除灵骏网段跨账号授权信息 删除某个灵骏网段的灵骏HUB跨账号授权,删除后相关数据丢失且不可恢复。
GetVpdGrantRule 查询灵骏网段跨账号授权信息详情 查询灵骏网段跨账号资源授权详情,包括授权租户ID,灵骏HUB实例ID,网络实例ID等。
ListVpdGrantRules 查询灵骏网段授权信息 查询一个或多个灵骏网段路由条目的详细信息,包括路由类型,路由条目状态,目的网段,下一条的实例信息等。
路由条目 路由条目
GetVpdRouteEntry 查询灵骏网段路由条目详情 查询路由条目。
ListVpdRouteEntries 查询灵骏网段路由条目 查询灵骏网段路由条目。

灵骏子网

API

标题

API概述

CreateSubnet 创建灵骏子网 用户可以使用该API在灵骏网段下创建一个灵骏子网。
DeleteSubnet 删除灵骏子网 删除某个灵骏子网实例,删除后相关数据丢失且不可恢复。
GetSubnet 查询灵骏子网详情 查询某个灵骏子网的详细信息,包括灵骏子网类型,网络地址段,所属灵骏网段实例ID,实例状态,NC数量等。
UpdateSubnet 更新灵骏子网 更新灵骏子网实例的部分信息,包括灵骏子网实例名称。
ListSubnets 查询灵骏子网 查询一个或多个灵骏子网的详细信息,包括灵骏子网类型,网络地址段,所属灵骏网段实例ID等。

灵骏连接

API

标题

API概述

InitializeVcc 初始化灵骏连接 初始化灵骏连接,授权智能计算灵骏在您的账号创建SLR。
DescribeSlr 查询SLR授权信息 查询用户是否存在灵骏连接需要的SLR角色-AliyunServiceRoleForEfloVcc。
CreateVcc 创建灵骏连接 用户可创建灵骏连接,用于连通灵骏网络环境和阿里云网络环境。
UpdateVcc 更新灵骏连接 更新灵骏连接实例的部分信息,包括灵骏连接实例的带宽峰值和名称。
GetVcc 查询灵骏连接详情 查询某个灵骏连接的详细信息,包括规格,物理专线接入端口类型,实例状态,带宽,BGP网段等。
ListVccs 查询灵骏连接 查询一个或多个灵骏连接的详细信息,包括规格,物理专线接入端口类型,实例状态,带宽,bgp网段等。
ListVccFlowInfos 查询灵骏连接流量信息 查询灵骏连接的流量速率信息。
RetryVcc 重试灵骏连接 重试尝试创建/删除灵骏连接。
跨账号授权 跨账号授权
CreateVccGrantRule 创建灵骏连接跨账号授权信息 用户可通过此API,将灵骏连接实例对目标账号的灵骏HUB实例授权。授权后,目标账号即可用被授权的灵骏HUB实例关联到您的灵骏连接。
DeleteVccGrantRule 删除灵骏连接跨账号授权信息 删除某个灵骏连接的灵骏HUB跨账号授权,删除后相关数据丢失且不可恢复。
GetVccGrantRule 查询灵骏连接跨账号资源授权详情 查询灵骏连接跨账号资源授权详情,包括授权租户ID,灵骏HUB实例ID,网络实例ID等。
ListVccGrantRules 查询灵骏连接跨账号授权信息 查询某个灵骏连接授权的详细信息,包括授权租户ID,地域,灵骏HUB实例信息等。
路由条目 路由条目
CreateVccRouteEntry 创建灵骏连接路由条目 创建灵骏连接路由条目。
DeleteVccRouteEntry 删除灵骏连接路由条目 删除灵骏连接路由条目。
GetVccRouteEntry 查询灵骏连接路由条目详情 查询路由条目。
ListVccRouteEntries 查询灵骏连接路由条目 查询灵骏连接路由条目。

灵骏弹性网卡

API

标题

API概述

CreateElasticNetworkInterface 创建灵骏弹性网卡 创建灵骏弹性网卡。
DeleteElasticNetworkInterface 删除灵骏弹性网卡 删除灵骏弹性网卡,删除后,相关数据全部丢失且不可恢复,请谨慎操作。
GetElasticNetworkInterface 获取灵骏弹性网卡详情 获取灵骏弹性网卡详情。
ListElasticNetworkInterfaces 查询灵骏弹性网卡列表 查询灵骏弹性网卡列表。
UpdateElasticNetworkInterface 更新灵骏弹性网卡 更新灵骏弹性网卡信息。
AttachElasticNetworkInterface 绑定灵骏弹性网卡 灵骏ENI绑定NC。
DetachElasticNetworkInterface 解绑灵骏弹性网卡 灵骏ENI解绑NC。
AssignLeniPrivateIpAddress 分配灵骏弹性网卡辅助私网IP 为当前的灵骏弹性网卡申请辅助私网IP(可选自动分配辅助私网IP)。
UnassignLeniPrivateIpAddress 取消分配灵骏弹性网卡辅助私网IP 将分配的灵骏弹性网卡辅助私网IP删除。
GetLeniPrivateIpAddress 获取灵骏弹性网卡辅助私网IP详情 获取指定灵骏弹性网卡辅助私网IP的详细信息。
UpdateLeniPrivateIpAddress 修改灵骏弹性网卡辅助私网描述 更新灵骏弹性网卡分配的辅助私网描述。
ListLeniPrivateIpAddresses 查询灵骏弹性网卡私网IP列表 查询当前灵骏弹性网卡辅助私网IP的列表信息。

灵骏网卡

API

标题

API概述

GetNetworkInterface 查询网卡实例信息 查询某张网卡实例信息。
ListNetworkInterfaces 查询灵骏网卡列表 查询灵骏网卡列表信息。
ListLniPrivateIpAddress 查询灵骏网卡私网IP列表 查询当前灵骏网卡辅助私网IP的列表信息。
AssignPrivateIpAddress 分配辅助私网IP 为当前的灵骏网卡申请辅助私网IP,以及可选自动分配辅助Mac地址。
UnAssignPrivateIpAddress 取消分配私网辅助IP 将分配的辅助私网IP地址删除。
GetLniPrivateIpAddress 获取私网IP详情 获取辅助私网IP详情信息。

灵骏HUB

API

标题

API概述

实例管理 实例管理
CreateEr 创建灵骏HUB 创建灵骏HUB。
DeleteEr 删除灵骏HUB 删除某个灵骏HUB实例,删除后相关数据丢失且不可恢复。
GetEr 查询灵骏HUB详情信息 查询灵骏HUB。
ListErs 查询灵骏HUB 查询灵骏HUB。
UpdateEr 更新灵骏HUB 更新灵骏HUB。
网络实例连接 网络实例连接
CreateErAttachment 创建网络实例连接 创建网络实例连接。
DeleteErAttachment 删除网络实例连接 删除某个网络实例连接实例,删除后相关数据丢失且不可恢复。
UpdateErAttachment 更新灵骏HUB网络连接 更新网络实例连接。
GetErAttachment 查询灵骏HUB网络实例连接详情 查询网络实例连接。
ListErAttachments 查询灵骏HUB网络连接 查询网络实例连接。
路由策略 路由策略
UpdateErRouteMap 更新灵骏HUB路由策略 更新路由策略的部分信息,包括路由策略的描述和名称。
ListErRouteMaps 查询灵骏HUB路由策略 查询路由策略。
GetErRouteMap 查询灵骏HUB路由策略详情 查询灵骏HUB路由策略详情信息。
DeleteErRouteMap 删除路由策略 删除某个路由策略实例,删除后相关数据丢失且不可恢复。
CreateErRouteMap 创建灵骏HUB路由策略 用户可以使用该API,通过指定灵骏HUB下的网络实例连接,创建路由策略。
路由条目 路由条目
GetErRouteEntry 查询灵骏HUB路由条目详情 查询灵骏HUB路由条目详情。
ListErRouteEntries 查询灵骏HUB路由条目 查询灵骏HUB路由条目。

网络通信距离

API

标题

API概述

ListInstancesByNcd 通过网络通信距离筛选实例 查询与指定GPU节点,通信距离不超过指定NCDGPU节点列表。
QueryInstanceNcd 查询实例网络通信距离 查询实例(灵骏节点、灵骏网卡)之间的网络通信距离(Network Communication Distance,NCD)。
GetFabricTopology 查询VPD下灵骏网卡和灵骏节点的物理拓扑信息 查询VPD下灵骏网卡和灵骏节点的物理拓扑信息。

其他

API

标题

API概述

GetNodeInfoForPod 查询节点网络信息详情 查询节点网络信息详情。
ListNodeInfosForPod 查询节点网络信息 查询节点网络信息。
GetDestinationCidrBlock 查询目的网段 用户可用该API查询创建路由策略时,源策略实例的目的网段
RefundVcc 退订灵骏连接 使用本API可以退订一个预支付的灵骏连接。
SwitchVccConnection 切换灵骏连接的连接实例 切换灵骏连接的连接实例包括:云企业网实例切换,专有网络实例切换,云企业网与专有网络实例的互相切换。