华为云用户手册

请求消息 请求参数如表2所示。 表2 请求参数 参数 参数类型 是否必选 描述 name String 是 弹性云服务器修改后的名称。 规则如下： 只能由中文字符、英文字母、数字及“_”、“-”、“.”组成，且长度为[1-128]个英文字符或[1-64]个中文字符。 批量修改弹性云服务器名称时，名不会自动按序增加数字尾缀。例如： 三个E CS 的名称为test_0001，test_0002，test_0003，批量修改弹性云服务器名称为develop，则修改后3个弹性云服务器名称为develop，develop，develop。 dry_run Boolean 否 是否只预检此次请求。 true：发送检查请求，不会修改云服务器名称。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回正常响应信息。 响应结构请参见 响应（批量操作类） 所示。 false：发送正常请求，通过检查后并且执行修改云服务器名称的请求。 默认值：false servers Array of objects 是 待修改的弹性云服务器ID信息，详情请参见 表3。 表3 servers字段数据结构说明 参数 参数类型 是否必选 描述 id String 是 弹性云服务器ID。

请求示例 批量修改ID为“260a0917-f7df-4b25-93ac-950da6c6b5d6”和“f6d8df1a-e257-48e2-b617-1dd92ced8c20”的云服务器的名称为“new-server-name”。 PUT https://{endpoint}/v1/{project_id}/cloudservers/server-name { "name": "new-server-name", "dry_run": false, "servers": [ { "id":"260a0917-f7df-4b25-93ac-950da6c6b5d6" }, { "id":"f6d8df1a-e257-48e2-b617-1dd92ced8c20" } ] }

响应消息 响应参数如表2所示。 表2 响应参数 参数 参数类型 描述 interfaceAttachments Array of objects 云服务器网卡信息列表，详情请参见表3。 attachableQuantity Object 云服务器可挂载网卡数，详情请参见表4 表3 interfaceAttachments字段数据结构说明 参数 参数类型 描述 port_state String 网卡端口状态。 fixed_ips Array of objects 网卡私网IP信息列表，详情请参见表5。 net_id String 网卡端口所属网络ID（network_id）。 port_id String 网卡端口ID。 mac_addr String 网卡Mac地址信息。 delete_on_termination Boolean 卸载网卡时，是否删除网卡。 true: 删除； false: 不删除 driver_mode String 网卡的驱动类型，预留字段，默认取值为virtio。 min_rate Integer 网卡带宽下限。 multiqueue_num Integer 队列个数。 取值范围为 1, 2, 4, 8, 16，28。 pci_address String 弹性网卡在Linux GuestOS里的BDF号。 说明： 网卡不支持时，返回为空。 表4 attachableQuantity字段数据结构说明 参数 参数类型 描述 free_nic Integer 云服务器剩余可挂载网卡数量。 表5 fixed_ips字段数据结构说明 参数 参数类型 描述 subnet_id String 网卡私网IP对应子网信息。 ip_address String 网卡私网IP信息。

响应示例 { "interfaceAttachments": [ { "port_state": "ACTIVE", "fixed_ips": [ { "subnet_id": "ba31e1f5-fa76-4530-862c-5176fad033cf", "ip_address": "192.168.0.33" } ], "net_id": "610a4af2-1d90-4d2b-8057-dc238b26febf", "port_id": "04819c0a-6a07-44b6-945e-fb932071888e", "mac_addr": "fa:16:3e:45:65:c4" } ] }

响应示例 { "flavor": { "name": "c3.2xlarge.2", "links": [ { "href": "https://compute.region.example.com/v2.1/743b4c0428d94531b9f2add666642e6b/flavors/c3.2xlarge.2", "rel": "self" }, { "href": "https://compute.region.example.com/743b4c0428d94531b9f2add666642e6b/flavors/c3.2xlarge.2", "rel": "bookmark" } ], "ram": 16384, "OS-FLV-DISABLED:disabled": false, "vcpus": 8, "swap": "", "os-flavor-access:is_public": true, "rxtx_factor": 1, "OS-FLV-EXT-DATA:ephemeral": 0, "disk": 0, "id": "c3.2xlarge.2" } }

响应消息 响应参数如表2所示。 表2 响应参数 参数 参数类型 描述 flavor Object 云服务器规格，详情请参见表3。 表3 flavor数据结构说明 参数 参数类型 描述 id String 云服务器规格ID。 name String 云服务器规格名称。 vcpus Integer 云服务器规格对应的CPU核数。 ram Integer 云服务器规格对应的内存大小，单位为MB。 disk Integer 云服务器规格对应要求系统盘大小。 当前未使用该参数，缺省值为0。 swap String 云服务器规格对应要求的交换分区大小。 当前未使用该参数，缺省值为""。 OS-FLV-EXT-DATA:ephemeral Integer 扩展属性，临时盘大小。 当前未使用该参数，缺省值为0。 OS-FLV-DISABLED:disabled Boolean 扩展属性，该云服务器规格是否禁用。 当前未使用该参数，缺省值为false。 rxtx_factor Float 云服务器可使用网络带宽与网络硬件带宽的比例。 当前未使用该参数，缺省值为1.0。 os-flavor-access:is_public Boolean 扩展属性，flavor是否给所有租户使用。 true：表示给所有租户使用。 false：表示给指定租户使用。 缺省值为true。 links Array of objects 规格相关快捷链接地址，详情请参见表4。 表4 links字段数据结构说明 参数 参数类型 描述 rel String 快捷链接标记名称。 href String 对应快捷链接。

安全组管理 权限 对应的API接口 授权项（Action） 依赖的授权项 IAM 项目 (Project) 企业项目 (Enterprise Project) 实例授权 标签授权 创建安全组（OpenStack原生）（废弃） POST /v2.1/{project_id}/os-security-groups ecs:securityGroups:use vpc:securityGroups:get vpc:securityGroups:create vpc:securityGroups:update √ × × × 删除安全组（OpenStack原生）（废弃） DELETE /v2.1/{project_id}/os-security-groups/{security_group_id} ecs:securityGroups:use vpc:securityGroups:get vpc:securityGroups:delete vpc:securityGroups:update √ × × × 查询安全组详细信息（OpenStack原生）(废弃) GET /v2.1/{project_id}/os-security-groups/{security_group_id} ecs:securityGroups:use vpc:securityGroups:get √ × × × 查询安全组列表（OpenStack原生）（废弃） GET /v2.1/{project_id}/os-security-groups ecs:securityGroups:use vpc:securityGroups:get √ × × × 创建安全组规则（OpenStack原生）（废弃） POST /v2.1/{project_id}/os-security-group-rules ecs:securityGroups:use vpc:securityGroups:get vpc:securityGroups:update vpc:securityGroupRules:get vpc:securityGroupRules:create √ × × × 删除安全组规则（OpenStack原生）（废弃） DELETE /v2.1/{project_id}/os-security-group-rules/{security_group_rule_id} ecs:securityGroups:use vpc:securityGroups:get vpc:securityGroups:update vpc:securityGroupRules:get vpc:securityGroupRules:delete √ × × × 更新安全组信息（OpenStack原生）（废弃） PUT /v2.1/{project_id}/os-security-groups/{security_group_id} ecs:securityGroups:use vpc:securityGroups:get vpc:securityGroups:update √ × × × 查询指定云服务器安全组列表（OpenStack原生）（废弃） GET /v2.1/{project_id}/servers/{server_id}/os-security-groups ecs:securityGroups:use vpc:securityGroups:get vpc:ports:get √ × × × 添加安全组（OpenStack原生）（废弃） POST /v2.1/{project_id}/servers/{server_id}/action ecs:securityGroups:use ecs:servers:get ecs:servers:list ecs:serverVolumes:use ecs:diskConfigs:use ecs:serverKeypairs:get vpc:securityGroups:get vpc:securityGroups:create vpc:securityGroups:update vpc:securityGroupRules:get vpc:networks:get vpc:subnets:get vpc:routers:get vpc:ports:get vpc:ports:update √ × × × 移除安全组（OpenStack原生）（废弃） POST /v2.1/{project_id}/servers/{server_id}/action ecs:securityGroups:use ecs:servers:get ecs:servers:list ecs:serverVolumes:use ecs:diskConfigs:use ecs:serverKeypairs:get vpc:securityGroups:get vpc:securityGroups:delete vpc:securityGroups:update vpc:securityGroupRules:get vpc:networks:get vpc:subnets:get vpc:routers:get vpc:ports:get vpc:ports:update √ × × × 父主题： 权限和授权项

响应示例 { "quota_set": { "cores": 20, "fixed_ips": 40, "floating_ips": 10, "id": "d9ebe43510414ef590a4aa158605329e", "injected_file_content_bytes": 10240, "injected_file_path_bytes": 255, "injected_files": 5, "instances": 20, "key_pairs": 100, "metadata_items": 128, "ram": 51200, "security_group_rules": 20, "security_groups": 50, "server_group_members": 10, "server_groups": 10 } }

响应消息 响应参数如表2所示。 表2 响应参数 参数 参数类型 描述 quota_set Object quota_set对象，详情请参见表3。 表3 quota_set参数信息 参数 参数类型 描述 cores Integer vcpu数量配额 fixed_ips Integer 固定IP数量配额，目前不支持此参数 floating_ips Integer 浮动IP数量配额，目前不支持此参数 id String project的UUID injected_file_content_bytes Integer 注入文件的文件大小配额，单位字节 injected_file_path_bytes Integer 注入文件的路径大小配额，单位字节，目前不支持此参数 injected_files Integer 注入文件数量配额 instances Integer 云服务器数量配额 key_pairs Integer 密钥对数量配额，目前不支持此参数 metadata_items Integer 元数据数量配额 ram Integer 内存配额，单位MB security_group_rules Integer 每个安全组规则的配额，目前不支持此参数 security_groups Integer 安全组数量配额，目前不支持此参数 server_groups Integer 云服务器组数量配额。 server_group_members Integer 云服务器组中云服务器个数配额。

响应示例 { "instanceAction": { "instance_uuid": "e723eb40-f56e-40f9-8c8c-caa517fe06ba", "user_id": "752be40780484291a9cc7ae50fff3e6d", "start_time": "2014-12-11T02:17:49.000000", "request_id": "req-5a429946-c9cc-45cc-b5bd-68864209e5cc", "action": "create", "message": null, "project_id": "89655fe61c4c4a08b9f3e7f9095441b8", "events": [ { "finish_time": "2014-12-11T02:17:58.000000", "start_time": "2014-12-11T02:17:50.000000", "traceback": null, "event": "compute_build_and_run_instance", "result": "Success" } ] } }

响应消息 响应参数如表2所示。 表2 响应参数 参数 参数类型 描述 instanceAction Object 云服务器操作行为，详情请参见表3。 表3 instanceAction字段数据结构说明 参数 是否必选 参数类型 描述 action 是 String 行为动作 instance_uuid 是 String 弹性云服务器ID，UUID格式 message 是 String 行为完成状态信息 project_id 是 String 项目ID request_id 是 String 请求ID start_time 是 String 行为开始时间 user_id 是 String 用户ID events 是 Array of objects 事件信息，详情参见表4 表4 events字段数据结构说明 参数 是否必选 参数类型 描述 event 是 String 行为动作名称 result 是 String 执行结果 traceback 是 String 异常信息 start_time 是 String 事件开始时间 finish_time 是 String 事件结束时间

响应示例 { "status": "SUC CES S", "entities": { "sub_jobs_total": 1, "sub_jobs": [ { "status": "SUCCESS", "entities": { "server_id": "bae51750-0089-41a1-9b18-5c777978ff6d" }, "job_id": "2c9eb2c5544cbf6101544f0635672b60", "job_type": "createSingleServer", "begin_time": "2016-04-25T20:04:47.591Z", "end_time": "2016-04-25T20:08:21.328Z", "error_code": null, "fail_reason": null } ] }, "job_id": "2c9eb2c5544cbf6101544f0602af2b4f", "job_type": "createServer", "begin_time": "2016-04-25T20:04:34.604Z", "end_time": "2016-04-25T20:08:41.593Z", "error_code": null, "fail_reason": null }

响应消息 响应参数如表2所示。 表2 响应参数 参数 参数类型 描述 status String Job的状态。 SUCCESS：成功。 RUNNING：运行中。 FAIL：失败。 INIT：正在初始化。 PENDING_PAYMENT : 包年/包月订单待支付。 说明： PENDING_PAYMENT状态为创建或者变更包年/包月的弹性云服务器提交订单完成后待支付状态。如果订单取消，该状态不会自动刷新，待14天后job会自动清理。 entities Object Job操作的对象。 根据不同Job类型，显示不同的内容，云服务器相关操作显示server_id，网卡相关操作显示nic_id。有子Job时为子job的详情。 详情请参见表3 job_id String 异步请求的任务ID。 job_type String 异步请求的任务类型。 begin_time String 开始时间。 end_time String 结束时间。 error_code String Job执行失败时的错误码。 Job执行成功后，该值为null。 fail_reason String Job执行失败时的错误原因。 Job执行成功后，该值为null。 message String 查询Job的API请求出现错误时，返回的错误消息。 code String 查询Job的API请求出现错误时，返回的错误码。 错误码和其对应的含义请参考通用请求返回值。 表3 entities字段数据结构说明 参数 参数类型 描述 server_id String 云服务器相关操作显示server_id。 nic_id String 网卡相关操作显示nic_id。 sub_jobs_total Integer 子任务数量。 sub_jobs Array of objects 每个子任务的执行信息。 详情请参见表4 表4 sub_jobs字段数据结构说明 参数 参数类型 描述 status String Job的状态。 SUCCESS：成功。 RUNNING：运行中。 FAIL：失败。 INIT：正在初始化。 entities Object Job操作的对象。根据不同Job类型，显示不同的内容，云服务器相关操作显示server_id，网卡相关操作显示nic_id。更多字段描述请参见表5。 job_id String 子任务的ID。 job_type String 子任务的类型。 begin_time String 开始时间。 end_time String 结束时间。 error_code String Job执行失败时的错误码。 Job执行成功后，该值为null。 fail_reason String Job执行失败时的错误原因。 Job执行成功后，该值为null。 表5 sub_jobs.entities字段数据结构说明 参数 参数类型 描述 server_id String 云服务器相关操作显示server_id。 nic_id String 网卡相关操作显示nic_id。 errorcode_message String 子任务执行失败的具体原因。

数据结构(查询云服务器详情) 表1 flavor参数（v1.0接口） 参数 参数类型 描述 id String 云服务器规格ID。 name String 云服务器规格名称。 disk String 该云服务器规格对应要求系统盘大小，0为不限制。 此字段在本系统中无效。 vcpus String 该云服务器规格对应的CPU核数。 ram String 该云服务器规格对应的内存大小，单位为MB。 gpus Array of objects 该云服务器规格对应的GPU卡信息。 详细内容，请参见表8。 asic_accelerators Array of objects 该云服务器规格对应的ASIC加速卡信息。 详细内容，请参见表9。 表2 flavor参数（v1.1接口） 参数 参数类型 描述 id String 云服务器规格ID。 name String 云服务器规格名称。 disk Integer 该云服务器规格对应要求系统盘大小，0为不限制。 此字段在本系统中无效。 vcpus Integer 该云服务器规格对应的CPU核数。 ram Integer 该云服务器规格对应的内存大小，单位为MB。 gpus Array of objects 该云服务器规格对应的GPU卡信息。 详细内容，请参见表8。 asic_accelerators Array of objects 该云服务器规格对应的ASIC加速卡信息。 详细内容，请参见表9。 表3 security_groups参数 参数 参数类型 描述 name String 安全组名称或者UUID。 id String 安全组ID。 表4 os-extended-volumes:volumes_attached 参数 参数 参数类型 描述 id String 磁盘ID，格式为UUID。 delete_on_termination String 删除云服务器时是否一并删除该磁盘。 true：是 false：否 微版本2.3及以上版本支持。 bootIndex String 云硬盘启动顺序。 0为系统盘。 非0为数据盘。 device String 云硬盘挂载盘符，即磁盘挂载点。 表5 metadata参数 参数 参数类型 描述 charging_mode String 云服务器的计费类型。 “0”：按需计费（即postPaid-后付费方式）。 “1”：按包年包月计费（即prePaid-预付费方式）。 "2"：竞价实例计费 metering.order_id String 按“包年/包月”计费的云服务器对应的订单ID。 metering.product_id String 按“包年/包月”计费的云服务器对应的产品ID。 vpc_id String 云服务器所属的虚拟私有云ID。 EcmResStatus String 云服务器的冻结状态。 normal：云服务器正常状态（未被冻结）。 freeze：云服务器被冻结。 freeze字段格式为“freeze,冻结场景,资源释放状态”。 冻结场景包括： arrear：欠费冻结 police：公安冻结 illegal：违规冻结 verify：客户未实名认证冻结 资源释放状态包括： deletable：冻结可释放 not_delete：冻结不可释放 说明： 当云服务器被冻结或者解冻后，系统默认添加该字段，且该字段必选。 metering.image_id String 云服务器操作系统对应的镜像ID。 metering.imagetype String 镜像类型，目前支持： 公共镜像（gold） 私有镜像（private） 共享镜像（shared） metering.resourcespeccode String 云服务器对应的资源规格。 metering.resourcetype String 云服务器对应的资源类型。 取值为“1”，代表资源类型为云服务器。 cascaded.instance_extrainfo String 系统内部虚拟机扩展信息。 image_name String 云服务器操作系统对应的镜像名称。 agency_name String 委托的名称。 委托是由租户管理员在 统一身份认证 服务（Identity and Access Management，IAM）上创建的，可以为弹性云服务器提供访问云服务器的临时凭证。 os_bit String 操作系统位数，一般取值为“32”或者“64”。 os_type String 操作系统类型，取值为：Linux、Windows。 __support_agent_list String 云服务器是否支持主机安全服务、主机监控。 “hss”：主机安全服务 “ces”：主机监控 lockCheckEndpoint String 回调URL，用于检查云服务器的加锁是否有效。 如果有效，则云服务器保持锁定状态。 如果无效，解除锁定状态，删除失效的锁。 lockSource String 云服务器来自哪个服务。 订单加锁（ORDER） lockSourceId String 云服务器的加锁来自哪个ID。 lockSource为“ORDER”时，lockSourceId为订单ID。 lockScene String 云服务器的加锁类型。 按需转包年/包月（TO_PERIOD_LOCK） virtual_env_type String IOS镜像创建虚拟机，"virtual_env_type": "IsoImage" 属性； 非IOS镜像创建虚拟机，在19.5.0版本以后创建的虚拟机将不会添加virtual_env_type 属性，而在此之前的版本创建的虚拟机可能会返回"virtual_env_type": "FusionCompute"属性 。 说明： virtual_env_type属性不允许用户增加、删除和修改。 表6 sys_tags参数 参数 参数类型 描述 key String 系统标签的Key值 value String 系统标签的value值 表7 image参数 参数 参数类型 描述 id String 镜像id 您可以根据镜像ID查询更多镜像信息，详细内容，请参见查询镜像列表。 表8 gpus参数 参数 参数类型 描述 name String GPU卡名称。 count Integer GPU卡数量。 memory_mb Integer GPU卡显存大小，单位为MB。 表9 asic_accelerators参数 参数 参数类型 描述 name String ASIC加速卡名称。 count Integer ASIC加速卡数量。 memory_mb Integer ASIC加速卡内存大小，单位为MB。 父主题： 数据结构

响应示例 { "volumeAttachment": { "device": "/dev/vdb", "serverId": "ab258e25-e351-47c7-b6e3-0749c5d9ed6a", "id": "54667652-3029-4af8-9222-2d53066fd61c", "volumeId": "54667652-3029-4af8-9222-2d53066fd61c" } }

请求消息 请求参数如表2所示。 表2 请求参数 参数 是否必选 参数类型 描述 volumeAttachment 是 Object 要挂载的卷相关信息，详情请参见表3。 表3 volumeAttachment数据结构说明 参数 是否必选 参数类型 描述 volumeId 是 String 待挂载磁盘的磁盘ID，UUID格式。 device 否 String 磁盘挂载点，如/dev/sda，/dev/sdb。 新增加的磁盘挂载点不能和已有的磁盘挂载点相同。 需要根据已有设备名称顺序指定，否则由系统自动生成。 说明： VBD磁盘挂载点只支持从/dev/vdb到/dev/vdx，建议按英文字母顺序进行挂载，否则可能出现云服务器中磁盘盘符错乱的情况。

响应消息 响应参数如表 响应参数所示。 表4 响应参数 参数 参数类型 描述 volumeAttachment object 云服务器挂载信息，详情请参见表5。 表5 volumeAttachment字段数据结构说明 参数 参数类型 描述 device String 设备名称。 serverId String 挂载的云服务器ID，UUID格式。 id String 卷的ID，UUID格式。 volumeId String 挂载ID，目前实现与卷UUID相同。

请求示例 挂载ID为“54667652-3029-4af8-9222-2d53066fd61c”的磁盘到指定云服务器，挂载点为“/dev/sdb”。 POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/os-volume_attachments { "volumeAttachment": { "volumeId": "54667652-3029-4af8-9222-2d53066fd61c", "device": "/dev/sdb" } }

响应示例 { "server": { "addresses": { "68269e6e-4a27-441b-8029-35373ad50bd9": [ { "addr": "192.168.0.3", "version": 4, "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:1b:35:78", "OS-EXT-IPS:type": "fixed" } ] }, "created": "2012-08-20T21:11:09Z", "flavor": { "id": "s3.xlarge.2", "links": [ { "href": "http://openstack.example.com/openstack/flavors/s3.xlarge.2", "rel": "bookmark" } ] }, "hostId": "65201c14a29663e06d0748e561207d998b343e1d164bfa0aafa9c45d", "id": "893c7791-f1df-4c3d-8383-3caae9656c62", "image": "", "links": [ { "href": "http://openstack.example.com/v2/openstack/servers/893c7791-f1df-4c3d-8383-3caae9656c62", "rel": "self" }, { "href": "http://openstack.example.com/openstack/servers/893c7791-f1df-4c3d-8383-3caae9656c62", "rel": "bookmark" } ], "metadata": {}, "name": "new-server-test", "progress": 0, "status": "ACTIVE", "tenant_id": "openstack", "updated": "2012-08-20T21:11:09Z", "user_id": "fake" } }

密码管理 权限 对应的API接口 授权项（Action） 依赖的授权项 IAM项目 (Project) 企业项目 (Enterprise Project) 实例授权 标签授权 一键重置弹性云服务器密码（企业项目） PUT /v1/{project_id}/cloudservers/{server_id}/os-reset-password ecs:cloudServers:resetServerPwd - √ √ √ √ 查询云服务器是否支持重置密码 GET /v1/{project_id}/cloudservers/{server_id}/os-resetpwd-flag ecs:cloudServers:showResetPasswordFlag - √ √ √ √ 获取Windows云服务器密码 GET /v1/{project_id}/cloudservers/{server_id}/os-server-password ecs:cloudServers:showServerPassword - √ √ √ √ 清除Windows云服务器密码 DELETE /v1/{project_id}/cloudservers/{server_id}/os-server-password ecs:cloudServers:deletePassword - √ √ √ √ 获取云服务器密码（OpenStack原生）（废弃） GET /v2.1/{project_id}/servers/{server_id}/os-server-password ecs:serverPasswords:manage - √ × × × 清除云服务器密码（OpenStack原生）（废弃） DELETE /v2.1/{project_id}/servers/{server_id}/os-server-password ecs:serverPasswords:manage - √ × × × 父主题： 权限和授权项

响应消息 响应参数如表4所示。 表4 响应参数 参数 参数类型 描述 fpga_image Object FPGA镜像信息详情。 表5 fpga_image字段结构说明 参数 参数类型 描述 id String FPGA镜像的ID。 status String FPGA镜像状态。取值如下： saving：表示FPGA镜像正在上传文件到后端存储。 deleting：表示FPGA镜像正在删除中。 error：表示FPGA镜像创建失败。 active：表示FPGA镜像可以正常使用。

请求示例 POST https://{endpoint}/v1/{project_id}/cloudservers/fpga_image { "fpga_image": { "location": "obs-fpga:fpga.bin", "name": "fpga-image-test", "description": "fpga description", "metadata": { "shell_type": "OCL", "shell_version": "1.0" } } }

请求消息 请求参数如表2所示。 表2 请求参数 参数 参数类型 是否必选 描述 fpga_image Object 是 FPGA镜像信息详情。 表3 fpga_image字段结构说明 参数 参数类型 是否必选 描述 location String 是 FPGA逻辑文件在OBS桶中的路径，格式为“桶名:文件名”，例如“obs-fpga:fpga.bin”。 桶名的命名规则满足OBS的约束： 由英文小写字母、数字以及特殊字符“.”、“-”组成。 只能以数字或字母开头和结尾。 长度3～63个字符。 不能是ip地址。 不能包含“..”、“.-” 、“-.”字符串。 文件名的命名规则如下： 由英文大、小写字母，数字，中划线，下划线，斜杠，英文句号组成。 必须以“.bin”或“xclbin”结尾。 长度4～64个字符。 name String 是 FPGA镜像的名称。 取值范围： 只能由英文字母、数字、下划线、中划线组成。 长度1~64个字符。 metadata Object 是 FPGA镜像的元数据信息，要求是合法的JSON（JavaScript Object Notation）对象类型。 metadata在进行JSON序列化后的字符个数不能超过1024。 description String 否 FPGA镜像的描述信息，由中文汉字、中文句号、中文逗号、英文大小写字母、数字、中划线、下划线、英文句号、英文逗号、空格组成，长度0到255个字符。

请求示例 创建一个智能购买组，名称为“test”，持续供应类型，目标容量为10，按需实例目标容量为5。 POST https://{endpoint}/v2/{domain_id}/auto-launch-groups { "name":"test", "guarantee_plan_id":"plan_id", "type":"maintain", "target_capacity":10, "stable_capacity":5, "excess_fulfilled_capacity_behavior":"terminate", "instances_behavior_with_expiration":"terminate", "valid_since":"2020-04-04T15:58:13Z", "valid_until":"2021-04-06T15:58:13Z", "region_specs":[ { "region_id":"region1", "expect_target_capacity":10, "expect_stable_capacity":5, "launch_template_config":{ "launch_template":{ "launch_template_id":"c516c350-7091-4490-9338-47ddb90360f2", "version":"1.0" }, "overrides":[ { "availability_zone_id":"az1", "flavor_id":"s3.large.2", "spot_price":2, "priority":4, "weighted_capacity":6 }, { "availability_zone_id":"az2", "flavor_id":"s3.large.2", "spot_price":2, "priority":4, "weighted_capacity":12 }, { "availability_zone_id":"az3", "flavor_id":"s3.large.2", "spot_price":2, "priority":4, "weighted_capacity":2 } ] } } ], "allocation_strategy":"lowest_price", "spot_price":0.5, "supply_option":"multiple", "dry_run":false }

请求参数 表2 请求参数 参数 是否必选 参数类型 描述 name 是 String 智能购买组名称。 取值范围：1-64个字符，只能包含中文、字母、数字、下划线和中划线。 dry_run 否 Boolean 创建智能购买组参数核查。 true：发送检查请求，不会创建智能购买组。检查项包括是否填写了必需参数、请求格式等。 如果检查不通过，则返回对应错误。 如果检查通过，则返回202状态码。 false：发送正常请求，通过检查后并且执行创建智能购买组请求。 type 否 String 请求类型。 request：一次性。仅在启动时交付实例集群，调度失败后不再重试。 maintain：持续供应。在启动时尝试交付实例集群，并监控容量，未达到目标容量则尝试继续创建ECS实例。 默认值：maintain guarantee_plan_id 否 String 算力保障计划ID。 target_capacity 是 Integer 智能购买组目标容量。 实例数量或者CPU个数目标容量大于等于stable_capacity。竞价实例的容量为满配容量减去stable_capacity。 stable_capacity 否 Integer 按需实例目标容量。 目标容量指实例数量或CPU个数，必须小于等于target_capacity，智能购买组中可以没有按需实例。 excess_fulfilled_capacity_behavior 否 String 超过目标容量或目标容量减少时的实例中断行为。 terminate：释放 noTermination：不释放 默认值：terminate instances_behavior_with_expiration 否 String 请求到期时正在运行实例的中断行为。 terminate：释放 noTermination：不释放 默认值：terminate valid_since 否 String 请求开始时间，和valid_until共同确定有效时段。 按照ISO8601标准表示，并使用UTC +0时间，格式为yyyy-MM-ddTHH:mm:ssZ。 默认值：立即生效 valid_until 否 String 请求结束时间，和valid_since共同确定有效时段。 按照ISO8601标准表示，并使用UTC +0时间，格式为yyyy-MM-ddTHH:mm:ssZ。 默认值：无限期 allocation_strategy 否 String 实例分配策略。 lowest_price：价格最低策略，智能购买组购买的所有实例的价格总和最低。 prioritized：优先级策略，按照规格设定的优先级创建实例。 capacity_optimized：容量最优化策略，智能购买组购买的实例按照大规格优先进行购买。 默认值：lowest_price region_specs 是 Array of objects 智能购买组内各区域的资源描述，详情请参见表3。 supply_option 否 String 资源供给中规格选择策略。 singlation：选择一种规格供给。 multiple：组合多种规格供给。 spot_price 否 Double 用户愿意为竞价实例每小时支付的最高价格。如果overrides中没有提供价格，可以使用该价格。 表3 region_specs参数信息 参数 是否必选 参数类型 描述 region_id 是 String 区域ID。 expect_target_capacity 是 Integer 区域内期望的总算力容量。 expect_stable_capacity 是 Integer 区域内期望的稳定算力容量。 launch_template_config 是 Object 启动模板配置，详情请参见表4。 表4 launch_template_config参数信息 参数 是否必选 参数类型 描述 launch_template 是 Object 实例的启动模板，详情请参见表5。 overrides 是 Array of objects 实例的详细信息，详情请参见表6。 表5 launch_template参数信息 参数 是否必选 参数类型 描述 launch_template_id 是 String 实例的启动模板ID，唯一标识一个启动模板。 version 是 String 启动模板版本号。 表6 override参数信息 参数 是否必选 参数类型 描述 availability_zone_id 是 String 可用区ID。 flavor_id 是 String 实例规格ID。 spot_price 否 Double 用户愿意为竞价实例每小时支付的最高价格。 priority 否 Integer 优先级。数值越小，优先级越高，优先购买。 取值范围：0到Integer.MAX_VALUE 默认值：Integer.MAX_VALUE weighted_capacity 否 Double 实例规格的权重。取值越高，单台实例满足计算力需求的能力越大，所需的实例数量越小。 取值范围：大于0 可以根据指定实例规格的计算力和集群单节点最低计算力得出权重值。 假设单节点最低计算力为8vCPU、60GB，则8vCPU、60GB实例规格的权重可设置为1，16vCPU、120GB实例规格的权重可设置为2。

请求消息 表2 请求参数 参数 是否必选 参数类型 描述 auto_terminate_time 是 String 按需云服务器定时删除时间。 按照ISO8601标准表示，并使用UTC +0时间，格式为yyyy-MM-ddTHH:mm:ssZ。 如果秒（ss）取值不是 00，则自动取为当前分钟（mm）开始时。 最短定时删除时间为当前时间半小时之后。 最长定时删除时间不能超过当前时间三年。 如果参数auto_terminate_time为空字符串，表示不设置定时删除或取消定时删除。 示例：2020-09-25T12:05:00Z

请求示例 设置云服务器的定时删除时间为“2020-09-25T12:05:00Z”。 POST https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/actions/update-auto-terminate-time { "auto_terminate_time": "2020-09-25T12:05:00Z", } 取消云服务器的定时删除。 POST https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/actions/update-auto-terminate-time { "auto_terminate_time": "", }

响应示例 { "security_groups": [ { "rules": [ { "from_port": null, "group": { "tenant_id": "bb1118612ba64af3a6ea63a1bdcaa5ae", "name": "default" }, "ip_protocol": null, "to_port": null, "parent_group_id": "bc4ac1d1-dc77-4b7d-a97d-af86eb0dc450", "ip_range": {}, "id": "bb3cc988-e06a-49f6-b668-600e8bf193ee" }, { "from_port": null, "group": { "tenant_id": "bb1118612ba64af3a6ea63a1bdcaa5ae", "name": "default" }, "ip_protocol": null, "to_port": null, "parent_group_id": "bc4ac1d1-dc77-4b7d-a97d-af86eb0dc450", "ip_range": {}, "id": "f9371051-d7e1-4be4-8748-77b1e0913730" } ], "tenant_id": "bb1118612ba64af3a6ea63a1bdcaa5ae", "description": "default", "id": "bc4ac1d1-dc77-4b7d-a97d-af86eb0dc450", "name": "default" }, { "rules": [ { "from_port": 200, "group": {}, "ip_protocol": "tcp", "to_port": 400, "parent_group_id": "b3e4b615-a40f-4e1c-92af-2e0d382141d5", "ip_range": { "cidr": "0.0.0.0/0" }, "id": "3330120d-bbd1-4a73-bda9-0196a84d5670" }, { "from_port": 201, "group": {}, "ip_protocol": "tcp", "to_port": 400, "parent_group_id": "b3e4b615-a40f-4e1c-92af-2e0d382141d5", "ip_range": { "cidr": "0.0.0.0/0" }, "id": "b550c9a6-970a-462d-984e-265e88020818" } ], "tenant_id": "bb1118612ba64af3a6ea63a1bdcaa5ae", "description": "desc-sg", "id": "b3e4b615-a40f-4e1c-92af-2e0d382141d5", "name": "test-sg" } ] }

URI DELETE /v2.1/{project_id}/servers/{server_id}/os-interface/{port_id} 参数说明请参见表1。 表1 参数说明 参数 是否必选 描述 project_id 是 项目ID。 获取方法请参见获取项目ID。 server_id 是 云服务器ID。 port_id 是 网卡Port ID。 说明： 当该ID为云服务器主网卡ID，将返回403。

FPGA逻辑文件管理 权限 对应的API接口 授权项（Action） 依赖的授权项 IAM项目 (Project) 企业项目 (Enterprise Project) 实例授权 标签授权 注册FPGA镜像 POST /v2/{project_id}/cloudservers/fpga_image ecs:cloudServerFpgaImages:create - √ × × × 查询关联列表 GET /v1/{project_id}/cloudservers/fpga_image/associations{?image_id,fpga_image_id,page,size} ecs:cloudServerFpgaImages:getRelations - √ × × × 解关联FPGA镜像与弹性云服务器镜像 DELETE /v1/{project_id}/cloudservers/fpga_image/{fpga_image_id}/association ecs:cloudServerFpgaImags:unrelate - √ × × × 查询FPGA镜像详情列表 GET /v1/{project_id}/cloudservers/fpga_image/detail ecs:cloudServerFpgaImages:list - √ × × × 删除FPGA镜像 DELETE /v1/{project_id}/cloudservers/fpga_image/{fpga_image_id} ecs:cloudServerFpgaImages:delete - √ × × × 关联FPGA镜像与弹性云服务器镜像 POST /v1/{project_id}/cloudservers/fpga_image/{fpga_image_id}/association ecs:cloudServerFpgaImages:relate - √ × × × 注册FPGA镜像 POST /v1/{project_id}/cloudservers/fpga_image ecs:cloudServerFpgaImages:register - √ × × × 父主题： 权限和授权项