CLI命令参考
物理连接
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询物理连接详情 | hcloud DC ShowDirectConnect | 查询物理连接详细信息. | |
| 更新物理连接信息 | hcloud DC UpdateDirectConnect | 更新物理连接信息,包括名字,描述等信息 | |
| 删除物理连接 | hcloud DC DeleteDirectConnect | 删除物理连接,本接口只适用于按需计费物理专线,对于包周期购买的专线通过订单退订的方式删除物理连接 | |
| 查询物理连接列表 | hcloud DC ListDirectConnects | 查询租户创建的所有的direct connect对象. | |
| 查询租户的托管专线列表 | hcloud DC ListHostedDirectConnects | 查询合作伙伴创建的托管专线连接列表. | |
| 创建托管专线连接 | hcloud DC CreateHostedDirectConnect | 用于合作伙伴用户最终租户创建托管专线 | |
| 查询租户的托管专线详情 | hcloud DC ShowHostedDirectConnect | 查询合法作伙伴的Hosted专线类型. | |
| 更新托管专线连接 | hcloud DC UpdateHostedDirectConnect | 合作伙伴更新托管专线. | |
| 删除托管专线连接 | hcloud DC DeleteHostedDirectConnect | 合作伙伴删除托管专线 |
虚拟网关
虚拟接口
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询虚拟接口详情 | hcloud DC ShowVirtualInterface | 查询虚拟接口详细信息 | |
| 更新虚拟接口 | hcloud DC UpdateVirtualInterface | 更新虚拟接口的详细信息 | |
| 删除虚拟接口 | hcloud DC DeleteVirtualInterface | 删除虚拟接口 | |
| 查询虚拟接口列表 | hcloud DC ListVirtualInterfaces | 查询租户所有的虚拟接口列表 | |
| 创建虚拟接口 | hcloud DC CreateVirtualInterface | 虚拟接口配置物理专线上与客户互联的IP和路由等相关信息 | |
| 修改虚拟接口可靠性检测的扩展参数 | hcloud DC UpdateExtendAttribute | 虚拟接口有bfd与nqa两种可靠性检测方式,您可以通过调用此接口修改可靠性检测的参数,例如检测报文最小发送间隔、检测报文最大发送间隔、检测周期等信息。 | |
| 更新虚拟接口对等体 | hcloud DC UpdateVifPeer | 更新虚拟接口对等体信息,包括远端子网,名字和描述等。 本接口只在支持Ipv6的区域开放,如需要使用请联系客服 | |
| 删除虚拟接口对应的对等体 | hcloud DC DeleteVifPeer | 删除虚拟接口对等体信息,虚拟接口至少要含一个对等体,最后一个对等体不能删除 本接口只在支持Ipv6的区域开放,如需要使用请联系客服 | |
| 创建虚拟接口对等体 | hcloud DC CreateVifPeer | 每个虚拟接口可支持两个对等体,IPv4和IPv6对等体,在创建虚拟接口时默认创建IPv4对等体, 本接口一般用于增加ipv6对等体。创建虚拟接口对接体之后,可以通过虚拟接口查询配置结果 本接口只在支持Ipv6的区域开放,如需要使用请联系客服 | |
| 执行虚拟接口倒换测试 | hcloud DC SwitchoverTest | 客户双专线接入,需要支持双线自动倒换,方便进行功能测试。 虚拟接口进行倒换测试会导致接口关闭,业务流量中断。 对于虚拟接口,支持“关闭接口”和“开放接口”两种操作。 1、关闭接口:下发shutdown命令,关闭接口; 2、开放接口:下发undo_shutdown命令,使能接口。 倒换测试选择shutdown时,虚拟接口的状态为ADMIN_SHUTDOWN,此状态不允许虚拟接口的其他操作。 倒换测试选择undo_shutdown时,虚拟接口的状态为ACTIVE。 | |
| 查询虚拟接口倒换测试记录列表 | hcloud DC ListSwitchoverTestRecords | 查询倒换测试记录列表,只展示operate_status为COMPELTE的记录。 |
标签管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询项目标签 | hcloud DC ListProjectTags | - 查询租户在指定Project中实例类型的所有资源标签集合。 | |
| 查询资源标签 | hcloud DC ShowResourceTag | 查询资源标签 | |
| 添加资源标签 | hcloud DC CreateResourceTag | - 一个资源上最多有10个标签。 | |
| 批量添加删除资源标签 | hcloud DC BatchCreateResourceTags | - 为指定实例批量添加或删除标签 | |
| 删除资源标签 | hcloud DC DeleteResourceTag | 删除时,不对标签字符集做校验,调用接口前必须要做encodeURI,服务端需要对接口uri做decodeURI。删除的key不存在报404,Key不能为空或者空字符串。 | |
| 通过标签查询资源实例 | hcloud DC ListTagResourceInstances | 通过标签查询资源实例 |
配额管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询配额 | hcloud DC ShowQuotas | 查询租户各类资源的使用情况,如Directconnect的使用量,虚拟接口的使用量等。 |
全域接入网关
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询专线全域接入网关列表 | hcloud DC ListGlobalDcGateways | 查询专线全域接入网关列表,建议使用分页查询 分页查询使用的参数为marker、limit。marker和limit一起使用时才会生效,单独使用无效 | |
| 创建专线全域接入网关 | hcloud DC CreateGlobalDcGateway | 创建专线全域接入网关实例(global-dc-gateway),用于接入全球的ER实例 | |
| 查询专线全域接入网关详情 | hcloud DC ShowGlobalDcGateway | 查询专线全域接入网关实例详情信息 | |
| 更新专线全域接入网关 | hcloud DC UpdateGlobalDcGateway | 更新专线全域接入网关global-dc-gateway的名字,描述等信息 | |
| 删除专线全域接入网关 | hcloud DC DeleteGlobalDcGateway | 删除专线全域接入网关global-dc-gateway实例 |
专线关联连接
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询专线关联连接列表 | hcloud DC ListPeerLinks | 查询全域接入网关与ER等对象的关联连接列表,分页查询使用的参数为marker、limit。marker和limit一起使用时才会生效,单独使用无效 | |
| 创建专线关联连接 | hcloud DC CreatePeerLink | 创建专线全域接入网关的关联连接peer-link对象,用于连接企业路由器或者其他接入网关 | |
| 查询专线关联连接详情 | hcloud DC ShowPeerLink | 查询指定接入网关的指定的关联连接(peer link)详情 | |
| 更新专线关联连接 | hcloud DC UpdatePeerLink | 更新接入网关与ER对接的关联连接peer-link | |
| 删除专线关联连接 | hcloud DC DeletePeerLink | 删除全域接入网关与ER的关联连接peer-link |
专线接入点管理
互联网关
GEIP操作管理
全域接入网关路由表
虚拟接口对等体连通性探测
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询虚拟接口对等体连通性探测实例 | hcloud DC ShowVifPeerDetection | 当您的对虚拟接口对等体发起连通性探测后,您可以通过此接口查询单次探测的信息,包括ID、探测开始时间、探测结束时间、探测状态、丢包率等。 | |
| 删除虚拟接口对等体连通性探测实例 | hcloud DC DeleteVifPeerDetection | 当您想不再保留虚拟接口对等体连通性探测实例时,您可以通过调用此接口将其删除。 | |
| 查询虚拟接口对等体连通性探测实例列表 | hcloud DC ListVifPeerDetections | 当您的对虚拟接口对等体发起连通性探测后,您可以通过此接口查询多次探测的信息,包括ID、探测开始时间、探测结束时间、探测状态、丢包率等。 | |
| 创建虚拟接口对等体连通性探测实例 | hcloud DC CreateVifPeerDetection | 当您想对虚拟接口对等体的远端网关的连通性进行探测时,可以通过调用此接口创建一个虚拟接口对等体连通性探测实例来实现。 |