本示例为混合云开放平台场景下通过OpneAPI接口使用Postman工具对云主机的操作实践。首先参考文档【调用前准备】做好调用前准备。创建弹性云主机#
创建弹性云主机之前咱们需要确定如下前置信息:需要创建的弹性云主机归属哪个资源池、弹性云主机需要使用哪种规格、安装什么操作系统、配置什么类型的存储和使用什么网络配置。接下来跟随示例步骤一步步确认信息后将可以成功创建一台属于自己的弹性云主机。1、确定创建的弹性云主机归属哪个资源池:
使用Postman调用资源池列表查询接口/v4/region/list-regions获取当前混合云管已纳管的资源池信息,在 返回信息中选择确定自己需要操作的(isMultiZones为true)资源池,确定好资源池后获取并记录下对应资源池的regionID(资源池ID)和zoneList(资源池azName)信息。
调用接口:2、确定弹性云主机可使用的规格。
使用Postman调用资源池弹性云主机规格信息查询接口/v4/common/get-ecs-flavors获取自己选择的资源池所支持的云主机规格信息。
接口入参示例:获取到弹性云主机规格信息后,从接口返回中根据规格信息确定自己需要开通的云主机规格,并记录下接口返回信息中对应的云主机规格的flavorID,flavorID为规格的唯一编号。3、 确定弹性云主机使用的磁盘类型。
使用Postman调用资源池产品信息查询接口/v4/region/get-products获取自己选择的资源池所支持的产品信息,此处咱们先暂时只使用接口返回的磁盘类型信息。
接口入参示例:从接口返回中获取returnObj-ebs-storageType信息,该信息为资源池所支持的磁盘类型信息,根据自己的需求选择合适的磁盘类型信息,并记录下磁盘类型对应的type值。4、确定弹性云主机使用的网络配置。
弹性云主机的网络配置可使用自己账号下已创建的网络配置,若未创建网络配置可参考创建和使用虚拟私有云VPC示例进行资源创建,并记录下对应资源的唯一ID。若已创建可使用如下接口查询自己归属的网络配置信息,并根据需要记录下对应资源的唯一ID。使用资源池regionID调用/v4/vpc/list,获取并记录下自己需使用的虚拟私有云的vpcID。
使用资源池regionID和虚拟私有云vpcID调用/v4/vpc/list-subnet,获取并记录下自己需要的子网的subnetID。
使用资源池regionID和虚拟私有云vpcID调用/v4/vpc/query-security-groups,获取并记录下自己需要的安全组的id。5、确定弹性云主机使用的镜像信息。
使用Postman调用资源池镜像信息查询接口/v4/image/list获取自己选择的资源池所支持的镜像信息,根据需求选择对应的镜像。
调用接口:获取到镜像结果后,记录下自己需要的镜像唯一编号imageID以及镜像大小diskSize等信息。6、创建弹性云主机。
通过步骤1-4咱们已确定要创建的弹性云主机的一些基本配置信息,接下来咱们可以调用创建弹性云主机的接口/v4/ecs/create创建一台符合咱们需求预期的云主机。
接口入参示例及含义:由于创建弹性云主机需要生成订单,计算计费,底层创建耗时不固定等原因,创建弹性云主机过程为异步过程。接口实时返回的为混合云工单号,获取到工单号后可以调用/v4/order/query-uuid接口以工单ID为入参查询工单执行情况,工单执行成功表示云主机创建成功;或者通过/v4/ecs/queryByResourceId接口以资源resourceID做入参查询云主机,接口有数据返回表示云主机创建成功。弹性云主机常用操作#
1、查询云主机详细信息与运行状态。
使用列表查询接口/v4/ecs/instance-list可查询当前用户下已创建好的弹性云主机信息,需确定查询的资源池信息入参。该接口还支持云主机ID,云主机名称,VPC,安全组等入参筛选条件,详细请参考接口文档。
接口返回信息包含云主机名称uuid,操作系统信息,运行状态,所属VPC、网卡等信息,详见接口返回示例和接口文档。
调用接口:2、云主机的启停操作。
通过云主机列表接口确定自己账号下的云主机基本信息后,可通过/v4/ecs/start和/v4/ecs/stop对自己的云主机进行启停等基本操作。操作前需确定具体的机器,通过传入云主机的UUID确定需要操作的对应资源。
入参示例:由于云主机的启停是一个异步操作。/v4/ecs/start和/v4/ecs/stop接口返回的为底层下发的异步执行的jobID,获取到接口的jobID后可调用/v4/job/info获取任务执行状态
入参示例:/v4/job/info接口返回的status为1表示任务执行成功,可通过云主机列表查询接口/v4/ecs/instance-list配合ID等入参,查询刚刚停止的云主机的vmState是否已变更为stopped。
3、获取云主机所属的宿主机信息。
入参示例:/v4/ecs/query-host-info通过改接口可获取云主机归属的宿主机的基本信息。另外还可以通过API接口获取云主机的网卡信息、绑定的云硬盘信息、元数据信息等信息,详细参考对应的API接口文档或者咨询混合云管API支持同事了解详情,这里不在一一列举。
3、云主机增加网卡。
首先需要确定操作的云主机,以及云主机新增网卡对应的子网网段,确定以上信息后可调用接口/v4/ecs/share-interface/attach为云主机添加网卡
入参示例:该操作为同步返回,返回的nicID为网卡UUID,通过接口/v4/ports/show使用该UUID可查询网卡基本信息。除此之外云主机的常用操作还包含云主机重装系统、云主机修改重置密码、挂起与恢复等 ,相关操作可参考对应的接口文档或者咨询混合云开放平台opneAPI支持同事。弹性云主机的变配与退订#
1、弹性云主机变配。
云主机变配分为冷变配和热变配,区别为变配下发前是否需要关闭云主机,其他变配流程相似,以下示例以冷变配为例,热变配参考对应接口文档。
弹性云主机的升配操作,只支持在同种架构之间进行变配,比如x86通用型云主机变配后的规格仍然只能威x86通用型云主机规格,不能变配为arm或x86计算增强型、海光等架构的云主机。
故在变配前需要确定改台云主机原来的规格配置,然后选择变配的对应架构下的其他规格进行变配操作,否则变配操作可能失败。
先查询云主机列表/v4/ecs/instance-list或云主机详情接口/v4/ecs/details获取需要变配的云主机的规格信息,规格信息在接口返回信息中的returnObj-results-flavor-specName中,确定好原规格信息后,调用/v4/common/get-ecs-flavors或/v4/ecs/flavor/list接口,使用原云主机的架构规格信息做入参获取对应架构下的其他规格信息。
入参示例:从以上规格查询接口返回的信息中确定自己云主机需要变配的规格,并记录下对应的规格号flavorID,再以flavorID做入参调用规格变更接口/v4/ecs/resize进行变配操作。
入参示例:弹性云主机变配过程为异步过程。接口实时返回的为混合云工单号,获取到工单号后可以调用/v4/order/query-uuid接口以工单ID为入参查询工单执行情况,工单执行成功表示云主机变配成功;或者调用/v4/ecs/instance-list接口查询变配云主机的详细信息,如果云主机详情中的规格信息已变化则表示云主机已变配成功。
2、弹性云主机退订。
弹性云主机通过opneAPI退订时是从底层直接销毁,不会进入云管界面的回收站,故通过openAPI进行云主机退订操作时需谨慎处理。
首先需要确定要销毁的云主机唯一编号UUID,然后以UUID作为入参调用释放接口进行资源释放。
入参示例:弹性云主机释放过程为异步过程。接口实时返回的为混合云工单号,获取到工单号后可以调用/v4/order/query-uuid接口以工单ID为入参查询工单执行情况,工单执行成功表示云主机释放成功;或者调用/v4/ecs/instance-list接口查询变配云主机的详细信息,如果云主机详情接口查询相关云主机返回结果为空则表示主机已释放成功。 修改于 2025-08-26 09:17:48