华为云用户手册

URI GET /v1/cloudimages/tags{?__isregistered,__imagetype,__whole_image,__system__cmkid,protected,visibility,owner,id,status,name,flavor_id,container_format,disk_format,min_ram,min_disk,__os_bit,__platform,marker,limit,sort_key,sort_dir,__os_type,tag,member_status,__support_kvm,__support_xen,__support_largememory,__support_diskintensive,__support_highperformance,__support_xen_gpu_type,__support_kvm_gpu_type,__support_xen_hana,__support_kvm_infiniband,virtual_env_type,enterprise_project_id,created_at,updated_at,architecture} 可以在URI后面用‘?’和‘&’添加不同的查询条件组合，请参考请求样例。 表1 查询参数 参数 是否必选 参数类型 描述 __isregistered 否 String 镜像是否可用，取值为true，扩展接口会默认为true，普通用户只能查询取值为true的镜像。 __imagetype 否 String 镜像类型，目前支持以下类型： 公共镜像：gold 私有镜像：private 共享镜像：shared 市场镜像：market 说明： 当前租户共享给其他租户的私有镜像或当前租户接受的共享镜像中，__imagetype均为shared，可用owner字段进行区分。当前租户接受的共享镜像可用member_status进行过滤查询。 __whole_image 否 Boolean 是否为整机镜像，取值为true/false。 __system__cmkid 否 String 加密镜像所使用的密钥ID。可以从 镜像服务 控制台获取，或者调用查询镜像详情（OpenStack原生）API查询。 protected 否 Boolean 镜像是否是受保护，取值为true/false，一般查询公共镜像时候取值为true，查询私有镜像可以不指定。 visibility 否 String 是否被其他租户可见，取值如下： public：公共镜像 private：私有镜像 shared：共享镜像 owner 否 String 镜像属于哪个租户。 id 否 String 镜像ID。 status 否 String 镜像状态。取值如下： queued：表示镜像元数据已经创建成功，等待上传镜像文件。 saving：表示镜像正在上传文件到后端存储。 deleted：表示镜像已经删除。 killed：表示镜像上传错误。 active：表示镜像可以正常使用。 name 否 String 镜像名称，匹配规则为精确匹配。name参数说明请参考镜像属性。 flavor_id 否 String 用于通过云服务器规格过滤出可用公共镜像，取值为规格ID。 约束： 仅支持通过单个规格进行过滤。 仅支持按照云服务器规格进行过滤，裸金属服务器暂不支持。 如果需要查看某裸金属服务器规格支持的公共镜像，可以使用“__support_s4l=true”标签。其中，s4l为裸金属服务器规格的board_type，若规格为“physical.s4.large”，则填入“s4l”。详细说明请参见“怎么确定裸金属服务器规格的board_type？”。调用示例请参考常用列表查询方法。 container_format 否 String 容器类型，取值为bare。 disk_format 否 String 镜像格式，目前支持zvhd2、vhd、zvhd、raw、qcow2、iso。非iso格式时默认值是zvhd2。 min_ram 否 Integer 镜像运行需要的最小内存，单位为MB。参数取值依据云服务器的规格限制，一般设置为0。 云服务器的规格限制，请参见规格清单。 min_disk 否 Integer 镜像运行需要的最小磁盘，单位为GB 。linux操作系统取值为10～1024GB，Windows操作系统取值为20～1024GB。 __os_bit 否 String 操作系统位数，一般取值为32或者64。 __platform 否 String 镜像平台分类，取值为Windows、Ubuntu、Red Hat、SUSE、CentOS、Debian、OpenSUSE、Oracle Linux、Fedora、Other、CoreOS和EulerOS。 marker 否 String 用于分页，表示从哪个镜像开始查询，取值为镜像ID。 limit 否 Integer 用于分页，表示查询几条镜像记录，取值为整数，默认取值为500。 sort_key 否 String 用于排序，表示按照哪个字段排序。取值为镜像属性name、container_format、disk_format、status、id、size、created_at字段，默认为创建时间。 sort_dir 否 String 用于排序，表示升序还是降序，取值为asc和desc。与sort_key一起组合使用，默认为降序desc。 __os_type 否 String 镜像系统类型，取值如下： Linux Windows Other tag 否 String 标签，用户为镜像增加自定义标签后可以通过该参数过滤查询。 说明： 系统近期对标签功能进行了升级。如果之前添加的Tag为“Key.Value”的形式，则查询的时候需要使用“Key=Value”的格式来查询。例如：之前添加的tag为“a.b”,则升级后，查询时需使用“tag=a=b”。 member_status 否 String 成员状态。目前取值有accepted、rejected、pending。accepted表示已经接受共享的镜像，rejected表示已经拒绝了其他用户共享的镜像，pending表示需要确认的其他用户的共享镜像。需要在查询时，设置“visibility”参数为“shared”。 __support_kvm 否 String 如果镜像支持KVM，取值为true，否则无需增加该属性。 __support_xen 否 String 如果镜像支持XEN，取值为true，否则无需增加该属性。 __support_largememory 否 String 表示该镜像支持超大内存。如果镜像支持超大内存，取值为true，否则无需增加该属性。 镜像操作系统类型请参考“弹性云服务器类型与支持的操作系统版本”。 __support_diskintensive 否 String 表示该镜像支持密集存储。如果镜像支持密集存储性能，则值为true，否则无需增加该属性。 __support_highperformance 否 String 表示该镜像支持高计算性能。如果镜像支持高计算性能，则值为true，否则无需增加该属性。 __support_xen_gpu_type 否 String 表示该镜像是支持XEN虚拟化平台下的GPU优化类型，取值参考表2。如果不支持XEN虚拟化下GPU类型，无需添加该属性。该属性与“__support_xen”和“__support_kvm”属性不共存。 __support_kvm_gpu_type 否 String 表示该镜像是支持KVM虚拟化平台下的GPU类型，取值参考表3。如果不支持KVM虚拟化下GPU类型，无需添加该属性。该属性与“__support_xen”和“__support_kvm”属性不共存。 __support_xen_hana 否 String 如果镜像支持XEN虚拟化下HANA类型，取值为true。否则，无需添加该属性。 该属性与“__support_xen”和“__support_kvm”属性不共存。 __support_kvm_infiniband 否 String 如果镜像支持KVM虚拟化下Infiniband网卡类型，取值为true。否则，无需添加该属性。 该属性与“__support_xen”属性不共存。 virtual_env_type 否 String 镜像使用环境类型：FusionCompute、Ironic、DataImage、IsoImage。 如果是云服务器镜像（即系统盘镜像），则取值为FusionCompute。 如果是数据盘镜像，则取值是DataImage。 如果是裸金属服务器镜像，则取值是Ironic。 如果是ISO镜像，则取值是IsoImage。 enterprise_project_id 否 String 表示查询某个企业项目下的镜像。 取值为0，表示查询属于default企业项目下的镜像。 取值为UUID，表示查询属于该UUID对应的企业项目下的镜像。 关于企业项目ID的获取及企业项目特性的详细信息，请参考“企业中心总览”。 created_at 否 String 镜像创建时间。支持按照时间点过滤查询，取值格式为“操作符:UTC时间”。 其中操作符支持如下几种： gt：大于 gte：大于等于 lt：小于 lte：小于等于 eq：等于 neq：不等于 时间格式支持：yyyy-MM-ddThh:mm:ssZ或者yyyy-MM-dd hh:mm:ss 例如，查询创建时间在2018-10-28 10:00:00之前的镜像，可以通过如下条件过滤： created_at=lt:2018-10-28T10:00:00Z updated_at 否 String 镜像修改时间。支持按照时间点过滤查询，取值格式为“操作符:UTC时间”。 其中操作符支持如下几种： gt：大于 gte：大于等于 lt：小于 lte：小于等于 eq：等于 neq：不等于 时间格式支持：yyyy-MM-ddThh:mm:ssZ或者yyyy-MM-dd hh:mm:ss 例如，查询修改时间在2018-10-28 10:00:00之前的镜像，可以通过如下条件过滤： updated_at=lt:2018-10-28T10:00:00Z architecture 否 String 镜像架构类型。取值包括： x86 arm

请求消息 请求参数 参数 是否必选 参数类型 描述 status 是 String 镜像成员的状态。 取值如下： accepted：表示接受共享镜像。接受后，该镜像在用户镜像列表中可见，用户可以使用该镜像创建云服务器。 rejected：表示拒绝共享镜像。拒绝后，该镜像在用户镜像列表中不可见，但是，用户仍然可以使用该镜像创建云服务器。 vault_id 否 String 存储库ID。 如果是CBR创建的整机镜像，则在接受该共享镜像时，为必选参数，需传入该值。 存储库ID可以从云备份服务控制台获取，或者参考“查询存储库列表”查询。

请求示例 更新镜像成员状态，其中，镜像状态为“接受共享镜像”。 1 2 3 4 PUT https://{Endpoint}/v2/images/d164b5df-1bc3-4c3f-893e-3e471fd16e64/members/edc89b490d7d4392898e19b2deb34797 { "status": "accepted" } 更新通过CBR创建的整机镜像成员状态，其中，镜像状态为“接受共享镜像”，存储库ID为“6yhtb5df-1bc3-4c3f-893e-3e4716yhgt61”。 1 2 3 4 5 PUT https://{Endpoint}/v2/images/d164b5df-1bc3-4c3f-893e-3e471fd16e64/members/edc89b490d7d4392898e19b2deb34797 { "status": "accepted", "vault_id": "6yhtb5df-1bc3-4c3f-893e-3e4716yhgt61" }

响应消息 响应参数 参数 参数类型 描述 status String 共享状态 created_at String 共享时间，格式为UTC时间 updated_at String 更新时间，格式为UTC时间 image_id String 镜像ID member_id String 成员ID schema String 共享视图 响应样例 STATUS CODE 200 1 2 3 4 5 6 7 8 { "status": "accepted", "created_at": "2016-09-01T02:05:14Z", "updated_at": "2016-09-01T02:37:11Z", "image_id": "d164b5df-1bc3-4c3f-893e-3e471fd16e64", "member_id": "edc89b490d7d4392898e19b2deb34797", "schema": "/v2/schemas/member" }

基本概念 账号 用户注册时的账号，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用用户进行日常管理工作。 用户 由账号在 IAM 中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。 在我的凭证下，您可以查看账号ID和IAM用户ID。通常在调用API的鉴权过程中，您需要用到账号、用户和密码等信息。 区域（Region） 从地理位置和网络时延维度划分，同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。Region分为通用Region和专属Region，通用Region指面向公共租户提供通用云服务的Region；专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region。 详情请参见区域和可用区。 可用区（AZ，Availability Zone） 一个可用区是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。 项目 区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中创建资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中的资源，使得资源的权限控制更加精确。 图1 项目隔离模型 同样在我的凭证下，您可以查看项目ID。 企业项目 企业项目是项目的升级版，针对企业不同项目间的资源进行分组和管理，是逻辑隔离。企业项目中可以包含多个区域的资源，且项目中的资源可以迁入迁出。 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理用户指南》。

功能介绍 该接口用于将镜像文件注册为云平台未初始化的私有镜像。 使用该接口注册镜像的具体步骤如下： 将镜像文件上传到OBS个人桶中。具体操作请参见“上传文件或文件夹”。 使用创建镜像元数据接口创建镜像元数据。调用成功后，保存该镜像的ID。创建镜像元数据请参考创建镜像元数据（OpenStack原生）。 根据2得到的镜像ID，使用注册镜像接口注册OBS桶中的镜像文件。 注册镜像接口作为异步接口，调用成功后，说明后台收到了注册请求。需要根据镜像ID查询该镜像状态验证镜像注册是否成功。当镜像状态变为“active”时，表示镜像注册成功。 如何查询异步任务，请参见异步任务查询。 注册镜像前请确保用户已拥有 对象存储服务 的Tenant Administrator权限。

URI PUT /v1/cloudimages/{image_id}/upload 参数说明请参见表1。 表1 参数说明 参数 是否必选 参数类型 描述 image_id 是 String 镜像ID。 image_id为用户调用创建镜像元数据接口所创建出来镜像的id，使用其他方式创建的镜像id会导致注册失败。 注册接口调用成功后，请根据镜像id查询镜像的状态。镜像状态变为active表示镜像注册成功，详情请参见查询镜像详情（OpenStack原生）。

URI PUT /v2/images/{image_id}/tags/{tag} 参数说明请参见表1。 表1 参数说明 参数 是否必选 参数类型 描述 image_id 是 String 镜像ID tag 是 String 新增的tag。 字符串中不能包含“=”。 说明： 该接口只能添加标签键，如果需要添加标签值，请使用接口PUT /v1/cloudimages/tags ，详情请参考增加或修改标签。

响应消息 响应参数 参数 参数类型 描述 file String 镜像文件下载和上传链接。 owner String 镜像属于哪个租户。 id String 镜像ID。 size Long 目前暂时不使用。 self String 镜像链接信息。 schema String 镜像视图。 status String 镜像状态。取值如下： queued：表示镜像元数据已经创建成功，等待上传镜像文件。 saving：表示镜像正在上传文件到后端存储。 deleted：表示镜像已经删除。 killed：表示镜像上传错误。 active：表示镜像可以正常使用。 tags Array of strings 镜像标签列表，提供用户可以自定义管理私有镜像的能力。用户可以通过镜像标签接口为每个镜像增加不同的标签，在查询接口中可以根据标签进行过滤。 visibility String 是否被其他租户可见。取值如下： private：私有镜像 public：公共镜像 shared：共享镜像 name String 镜像名称。name参数说明请参考镜像属性。 checksum String 目前暂时不使用。 protected Boolean 是否是受保护的，受保护的镜像不允许删除。取值为true或false。 container_format String 容器类型。 min_ram Integer 镜像运行需要的最小内存，单位为MB。参数取值依据云服务器的规格限制，默认设置为0。 云服务器的规格限制，请参见规格清单。 max_ram String 镜像支持的最大内存，单位为MB。参数取值可以参考云服务器的规格限制，默认不设置。 云服务器的规格限制，请参见规格清单。 updated_at String 更新时间。格式为UTC时间。 __os_bit String 操作系统位数，一般取值为“32”或者“64”。 __os_version String 操作系统具体版本。 __description String 镜像描述信息。_description参数说明请参考镜像属性。 disk_format String 镜像格式，目前支持zvhd2、vhd、zvhd、raw、qcow2、iso。非iso格式时默认值是zvhd2。 __isregistered String 是否是注册过的镜像，取值为“true”或者“false”。 __platform String 镜像平台分类，取值为Windows、Ubuntu、Red Hat、SUSE、CentOS、Debian、OpenSUSE、Oracle Linux、Fedora、Other、CoreOS和EulerOS。 __os_type String 操作系统类型，目前取值Linux、Windows、Other。 __system__cmkid String 加密镜像所使用的密钥ID。 min_disk Integer 镜像运行需要的最小磁盘容量，单位为GB 。linux操作系统取值为10～1024GB，Windows操作系统取值为20～1024GB。 virtual_env_type String 镜像使用环境类型：FusionCompute、Ironic、DataImage、IsoImage。 如果是云服务器镜像（即系统盘镜像），则取值为FusionCompute。 如果是数据盘镜像，则取值是DataImage。 如果是裸金属服务器镜像，则取值是Ironic。 如果是ISO镜像，则取值是IsoImage。 __image_source_type String 镜像后端存储类型，目前只支持uds。 __imagetype String 镜像类型，目前支持： 公共镜像（gold） 私有镜像（private） 共享镜像（shared） 市场镜像（market） created_at String 创建时间。格式为UTC时间。 virtual_size Integer 目前暂时不使用。 __originalimagename String 父镜像ID。 公共镜像或通过文件创建的私有镜像，取值为空。 __backup_id String 备份ID。如果是备份创建的镜像，则填写为备份的ID，否则无此参数。 __productcode String 市场镜像的产品ID。 __image_size String 镜像文件的大小，单位为字节。必须大于0。 __data_origin String 镜像来源。 公共镜像为空。 __root_origin String 表示当前镜像来源是从外部导入。取值：file。 __lazyloading String 镜像是否支持延迟加载。取值为true、false、True或False。 active_at String 镜像状态变为正常的时间。 __os_feature_list String 镜像附加属性。该属性采用JSON格式来标识镜像支持的高级特性清单。 __account_code String 收费镜像标识。 hw_firmware_type String 云服务器的启动方式。目前支持： bios：表示bios引导启动。如果无此参数，表示bios启动方式。 uefi：表示uefi引导启动。 说明： 当镜像的架构类型为ARM时，启动方式只支持uefi。 hw_vif_multiqueue_enabled String 镜像是否支持网卡多队列。取值为“true”或者“false”。 __support_kvm String 如果镜像支持KVM，取值为true，否则无需增加该属性。 __support_xen String 如果镜像支持XEN，取值为true，否则无需增加该属性。 __support_largememory String 表示该镜像是否支持超大内存特性。如果镜像支持超大内存，取值为true，否则无此属性。 镜像操作系统类型请参考“弹性云服务器类型与支持的操作系统版本”。 __support_diskintensive String 表示该镜像是否支持密集存储性特性。如果镜像支持密集存储性能，则值为true，否则无此属性。 __support_highperformance String 表示该镜像是否支持高计算性能的特性。如果镜像支持高计算性能，则值为true，否则无此属性。 __support_xen_gpu_type String 表示该镜像是支持XEN虚拟化平台下的GPU类型，取值参考表2。如果不支持，则无此属性。该属性与“__support_xen”和“__support_kvm”属性不共存。 __support_kvm_gpu_type String 表示该镜像是支持KVM虚拟化平台下的GPU类型，取值参考表3。 如果不支持，则无此属性。该属性与“__support_xen”和“__support_kvm”属性不共存。 __support_xen_hana String 如果镜像支持XEN虚拟化下HANA类型，取值为true。否则，无此属性。 该属性与“__support_xen”和“__support_kvm”属性不共存。 __support_kvm_infiniband String 如果镜像支持KVM虚拟化下Infiniband网卡类型，取值为true。否则，无此属性。 该属性与“__support_xen”属性不共存。 __is_offshelved String 表示当前市场镜像是否下架。 true：已下架 false：未下架 enterprise_project_id String 表示当前镜像所属的企业项目。 取值为0或无该值，表示属于default企业项目。 取值为UUID，表示属于该UUID对应的企业项目。 关于企业项目特性的详细信息，请参考“企业中心总览”。 __sequence_num String 表示当前镜像对应云服务器的系统盘插槽位置。 目前暂不使用。 __support_fc_inject String 表示当前镜像支持Cloud-Init密码/密钥注入方式。 如果取值为“true”，表示该镜像不支持Cloud-Init注入密码/密钥，其他取值时表示支持Cloud-Init注入密钥/密码。 说明： 该特性参数只对E CS 系统盘镜像生效，其他类型镜像不生效。 __support_arm String 是否为ARM架构类型的镜像。取值为“true”或者“false”。 __image_location String 镜像的存储位置。 __is_config_init String 是否完成了初始化配置。取值为“true”或者“false”。 __support_amd String 是否是AMD架构类型的镜像。取值为“true”或者“false”。 __support_agent_list String 镜像是否支持主机安全或主机监控。 hss：主机安全 主机安全服务（Host Security Service，HSS）是提升服务器整体安全性的服务，通过主机管理、风险防御、入侵检测、安全运营、网页防篡改功能，可全面识别并管理云服务器中的信息资产，实时监测云服务器中的风险，降低服务器被入侵的风险。 ces：主机监控 监控是保持弹性云服务器可靠性、可用性和性能的重要部分，通过监控，用户可以观察弹性云服务器资源。为使用户更好地掌握自己的弹性云服务器运行状态，云服务平台提供了 云监控 。您可以使用该服务监控您的弹性云服务器，执行自动实时监控、告警和通知操作，帮助您更好地了解弹性云服务器的各项性能指标。 取值样例： "__support_agent_list": "hss,ces" 说明： 如果查询结果无此字段，表示镜像不支持主机安全或主机监控。 响应样例 STATUS CODE 200 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 { "file": "/v2/images/33ad552d-1149-471c-8190-ff6776174a00/file", "owner": "0b1e494e2660441a957313163095fe5c", "id": "33ad552d-1149-471c-8190-ff6776174a00", "size": 2, "self": "/v2/images/33ad552d-1149-471c-8190-ff6776174a00", "schema": "/v2/schemas/image", "status": "active", "tags": [], "visibility": "private", "name": "ims_test", "checksum": "99914b932bd37a50b983c5e7c90ae93b", "protected": false, "container_format": "bare", "min_ram": 0, "updated_at": "2015-12-08T02:30:49Z", "__os_bit": "64", "__os_version": "Ubuntu 14.04 server 64bit", "__description": "ims test", "disk_format": "vhd", "__isregistered": "true", "__platform": "Ubuntu", "__os_type": "Linux", "min_disk": 40, "virtual_env_type": "FusionCompute", "__image_source_type": "uds", "__imagetype": "private", "created_at": "2015-12-04T09:45:33Z", "virtual_size": 0, "__originalimagename": "33ad552d-1149-471c-8190-ff6776174a00", "__backup_id": "", "__productcode": "", "__image_size": "449261568", "__data_origin": null, "hw_firmware_type":"bios" }

请求示例 通过V2.1版本更新镜像名称为ims_test01。 1 2 3 4 5 6 7 8 9 PATCH https://{Endpoint}/v2/images/33ad552d-1149-471c-8190-ff6776174a00 "Content-Type:application/openstack-images-v2.1-json-patch" [ { "op": "replace", "path": "/name", "value": "test01" } ] 通过V2.0版本更新镜像名称为ims_test01。 1 2 3 4 5 6 7 8 PATCH https://{Endpoint}/v2/images/33ad552d-1149-471c-8190-ff6776174a00 "Content-Type:application/openstack-images-v2.0-json-patch" [ { "replace": "/name", "value": "test01" } ]

请求消息 请求参数 Glance有两种方式的更新操作，通过http header里的Content-Type指定，当前支持“application/openstack-images-v2.0-json-patch”、“application/openstack-images-v2.1-json-patch”两种Content-Type。不同的Content-Type区别只是请求消息体格式不同。 表2 v2.1版本请求消息体 参数 是否必选 参数类型 描述 [数组] 是 Array of objects 详情请参见表3。 表3 [数组]字段说明 参数 参数类型 是否必选 描述 op String 是 所需进行的更新操作的类型：替换、添加、删除。 取值范围：replace、add、remove path String 是 所要操作的属性名称。 replace和remove操作取值只能是镜像当前已有的属性；add操作取值可以为当前已有属性和不存在的属性，如果为已有属性则执行效果同replace，如果是不存在的属性则执行add，需要在属性名称前加“/”。 value String 否 所需更新/添加属性的值。 根据op的value决定，replace、add需要指定，remove不需要 表4 v2.0版本请求消息体 参数 是否必选 参数类型 描述 [数组] 是 Array of objects 详情请参见表5。 表5 [数组]字段说明 参数 参数类型 是否必选 描述 replace String 取值三选一 key为replace表示替换镜像的相关属性，值为所要替换的属性需要在属性名称前加“/” add String key为add表示添加镜像属性，值为所要添加的属性名称，需要在属性名称前加“/” remove String key为remove表示删除镜像属性，值为所要删除的属性名称需要在属性名称前加“/” value String 根据前面的key决定，replace和add需要指定，remove不需要。 所需更新/添加的属性的值。参数说明请参考镜像属性。

响应消息 响应参数 参数 参数类型 描述 status String 共享状态。 created_at String 共享时间，格式为UTC时间。 updated_at String 更新时间，格式为UTC时间。 image_id String 镜像ID member_id String 成员ID，即接受镜像用户的项目ID。 schema String 共享视图 响应样例 STATUS CODE 200 1 2 3 4 5 6 7 8 { "status": "pending", "created_at": "2016-09-01T02:05:14Z", "updated_at": "2016-09-01T02:05:14Z", "image_id": "d164b5df-1bc3-4c3f-893e-3e471fd16e64", "member_id": "edc89b490d7d4392898e19b2deb34797", "schema": "/v2/schemas/member" }

响应消息 响应参数 参数 参数类型 描述 job_id String 任务ID。 job_type String 任务类型。 imsCreateImageByInstance：云服务器制作镜像 imsImportImageJob：外部镜像文件创建镜像 imsImportOvaImageJob：外部Ova镜像文件创建镜像 imsVolumeCreateImageJob：数据盘制作数据盘镜像 imsImportDataImageJob：外部镜像文件制作数据盘镜像 imsCreateWholeImageByInstanceJob：云服务器制作整机镜像 imsCreateWholeImageByBackupJob：云备份或云服务器备份制作整机镜像 imsNativeImportImageJob：注册镜像 imsNativeExportImageJob：导出镜像 imsAddImageMembersJob：添加镜像成员 imsDelImageMembersJob：删除镜像成员 imsUpdateImageMembersJob：修改镜像成员 imsCopyImageInRegionJob：Region内复制镜像 imsCopyImageCrossUserJob：跨Region复制镜像 begin_time String 任务开始执行时间。格式为UTC时间。 end_time String 任务结束时间。格式为UTC时间。 status String 任务状态，目前取值如下： SUC CES S：表示该任务执行已经结束，任务执行成功。 FAIL：表示该任务执行已经结束，任务执行失败。 RUNNING：表示该任务正在执行。 INIT：表示该任务还未执行，正在初始化。 error_code String 错误码。 fail_reason String 失败原因。 entities Object 任务自定义属性。 任务正常时，返回镜像的ID；任务异常时，返回错误码和信息。 详情请参见表2。 表2 entities字段数据结构说明 参数 参数类型 描述 image_name String 镜像名称。 process_percent Double 任务执行进度。 current_task String 当前任务名称。 subJobId String 子任务ID。 image_id String 镜像ID。 sub_jobs_result Array of SubJobResult objects 子任务执行结果。详情请参见表3。 sub_jobs_list Array of string 子任务id列表。 表3 SubJobResult字段数据结构说明 参数 参数类型 描述 status String 子任务状态，取值如下： SUCCESS：表示该任务执行已经结束，任务执行成功。 FAIL：表示该任务执行已经结束，任务执行失败。 RUNNING：表示该任务正在执行。 INIT：表示该任务还未执行，正在初始化。 job_id String 子任务ID。 job_type String 子任务类型。 begin_time String 子任务开始执行时间。格式为UTC时间。 end_time String 子任务结束时间。格式为UTC时间。 error_code String 错误码。 fail_reason String 失败原因。 entities Object 子任务自定义属性。详情请参见表4 任务正常时，返回镜像的ID。 任务异常时，返回错误码和信息。 表4 SubJobEntities字段数据结构说明 参数 参数类型 描述 image_id String 镜像ID。 image_name String 镜像名称。 响应样例 STATUS CODE 200 { "job_id": "ff80808280c204e30180d2784c3c0d86", "job_type": "imsCopyImageInRegionJob", "begin_time": "2022-05-17T14:42:20.859Z", "end_time": "", "status": "RUNNING", "error_code": null, "fail_reason": null, "entities": { "image_name": "d0d2e701-dfc4-4520-9247-f92907f38eb0", "process_percent": 0.40, "current_task": "CopyImageInRegionTask:", "subJobId": "ff80808280ca6cd30180d278b9db0221", "image_id": "498cc67e-7795-482c-8c47-32bcece2d7ec" } }

响应消息 响应参数 参数 参数类型 描述 Status String 镜像状态 Virtual_size Integer 镜像虚拟大小 Name String 镜像名称 Deleted Boolean 镜像是否已删除 Container_format String 镜像容器类型 Created_at String 镜像创建时间 Disk_format String 镜像文件类型 Updated_at String 镜像更新时间 Property Object 镜像属性 Owner String 镜像所属租户 Protected Boolean 镜像是否受保护 Min_ram Integer 运行镜像所需最小内存，单位MB Checksum String 镜像校验和，上传镜像文件后存在 Min_disk Integer 运行镜像所需最小磁盘，单位GB Is_public Boolean 是否为公共镜像 Deleted_at String 镜像删除时间 Id String 镜像UUID Size Integer 镜像大小，上传镜像文件后存在 上述响应参数在HTTP响应消息的header中返回。 响应样例 HTTP/1.1 200 OK 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 Content-Type: text/html; charset=UTF-8 Content-Length: 0 X-Image-Meta-Id: 3c3d1d01-b48a-4639-8a88-08be3b9b5d78 X-Image-Meta-Deleted: False X-Image-Meta-Container_format: bare X-Image-Meta-Checksum: 64d7c1cd2b6f60c92c14662941cb7913 X-Image-Meta-Protected: False X-Image-Meta-Min_disk: 0 X-Image-Meta-Created_at: 2016-05-22T06:04:20.425843 X-Image-Meta-Size: 13167616 X-Image-Meta-Status: active X-Image-Meta-Is_public: True X-Image-Meta-Min_ram: 0 X-Image-Meta-Owner: 23f4cb75768d4febb39542ef6fe169f3 X-Image-Meta-Updated_at: 2016-05-22T06:04:22.719791 X-Image-Meta-Disk_format: qcow2 X-Image-Meta-Name: cirros Etag: 64d7c1cd2b6f60c92c14662941cb7913 X-Openstack-Request-Id: req-7123ca83-da23-4f4e-9ed6-accd3707d333 Date: Mon, 23 May 2016 02:29:54 GMT

响应消息 响应参数 参数 参数类型 描述 file String 镜像文件下载和上传链接。 owner String 镜像属于哪个租户。 id String 镜像ID。 size Long 目前暂时不使用。 self String 镜像链接信息。 schema String 镜像视图。 status String 镜像状态。取值如下： queued：表示镜像元数据已经创建成功，等待上传镜像文件。 saving：表示镜像正在上传文件到后端存储。 deleted：表示镜像已经删除。 killed：表示镜像上传错误。 active：表示镜像可以正常使用。 tags Array of strings 镜像标签列表，提供用户可以自定义管理私有镜像的能力。用户可以通过镜像标签接口为每个镜像增加不同的标签，在查询接口中可以根据标签进行过滤。 visibility String 是否被其他租户可见，取值如下： private：私有镜像 public：公共镜像 shared：共享镜像 name String 镜像名称。name参数说明请参考镜像属性。 checksum String 目前暂时不使用。 protected Boolean 是否是受保护的，受保护的镜像不允许删除。取值为true或false。 container_format String 容器类型。 min_ram Integer 镜像运行最小内存，单位为MB。取值参考云服务器规格限制，一般设置为0。 云服务器的规格限制，请参见规格清单。 max_ram String 镜像支持的最大内存，单位为MB。取值可以参考云服务器规格限制，一般不设置。 云服务器的规格限制，请参见规格清单。 updated_at String 更新时间。格式为UTC时间。 __os_bit String 操作系统位数，一般取值为“32”或者“64”。 __os_version String 操作系统具体版本。 __description String 镜像描述信息。_description参数说明请参考镜像属性。 disk_format String 镜像格式，目前支持zvhd2、vhd、zvhd、raw、qcow2、iso。非iso格式时默认值是zvhd2。 __isregistered String 是否是注册过的镜像，取值为“true”或者“false”。 __platform String 镜像平台分类，取值为Windows、Ubuntu、Red Hat、SUSE、CentOS、Debian、OpenSUSE、Oracle Linux、Fedora、Other、CoreOS和EulerOS。 __os_type String 操作系统类型，目前取值Linux、Windows、Other。 __system__cmkid String 加密镜像所使用的密钥ID。 min_disk Integer 镜像运行需要的最小磁盘容量，单位为GB 。linux操作系统取值为10～1024GB，Windows操作系统取值为20～1024GB。 virtual_env_type String 镜像使用环境类型：FusionCompute、Ironic、DataImage、IsoImage。 如果是云服务器镜像（即系统盘镜像），则取值为FusionCompute。 如果是数据盘镜像，则取值为DataImage。 如果是裸金属服务器镜像，则取值为Ironic。 如果是ISO镜像，则取值是IsoImage。 __image_source_type String 镜像后端存储类型，目前只支持uds。 __imagetype String 镜像类型，目前支持以下类型： 公共镜像：gold 私有镜像：private 共享镜像：shared 市场镜像：market created_at String 创建时间。格式为UTC时间。 virtual_size Integer 目前暂时不使用。 __originalimagename String 父镜像ID。 公共镜像或通过文件创建的私有镜像，取值为空。 __backup_id String 备份ID。如果是备份创建的镜像，则填写为备份的ID，否则为空。 __productcode String 市场镜像的产品ID。 __image_size String 镜像文件的大小，单位为字节。目前取值为大于0的字符串。 __data_origin String 镜像来源。 公共镜像为空。 __root_origin String 表示当前镜像来源是从外部导入。取值：file。 __lazyloading String 镜像是否支持延迟加载。取值为true、false、True或False。 active_at String 镜像状态变为正常的时间。 __os_feature_list String 镜像附加属性。该属性采用JSON格式来标识镜像支持的高级特性清单。 __sequence_num String 目前暂时不用 __support_kvm String 如果镜像支持KVM，取值为true，否则无需增加该属性。 __support_xen String 如果镜像支持XEN，取值为true，否则无需增加该属性。 __support_largememory String 表示该镜像支持超大内存。如果镜像支持超大内存，取值为true，否则无需增加该属性。 镜像操作系统类型请参考“弹性云服务器类型与支持的操作系统版本”。 __support_diskintensive String 表示该镜像支持密集存储。如果镜像支持密集存储性能，则值为true，否则无需增加该属性。 __support_highperformance String 表示该镜像支持高计算性能。如果镜像支持高计算性能，则值为true，否则无需增加该属性。 __support_xen_gpu_type String 表示该镜像是支持XEN虚拟化平台下的GPU优化类型，取值参考表2。如果不支持XEN虚拟化下GPU类型，无需添加该属性。该属性与“__support_xen”和“__support_kvm”属性不共存。 __support_kvm_gpu_type String 表示该镜像是支持KVM虚拟化平台下的GPU类型，取值参考表3。 如果不支持KVM虚拟化下GPU类型，无需添加该属性。该属性与“__support_xen”和“__support_kvm”属性不共存。 __support_xen_hana String 如果镜像支持XEN虚拟化下HANA类型，取值为true。否则，无需添加该属性。 该属性与“__support_xen”和“__support_kvm”属性不共存。 __support_kvm_infiniband String 如果镜像支持KVM虚拟化下Infiniband网卡类型，取值为true。否则，无需添加该属性。 该属性与“__support_xen”属性不共存。 __support_fc_inject String 表示当前镜像支持Cloud-Init密码/密钥注入方式，取值为“true”或者“false”。 如果取值为“true”，表示该镜像不支持Cloud-Init注入密码/密钥，其他取值时表示支持Cloud-Init注入密钥/密码。 说明： 该特性参数只对ECS系统盘镜像生效，其他类型镜像不生效。 enterprise_project_id String 表示当前镜像所属的企业项目。 取值为0或无该值，表示属于default企业项目。 取值为UUID，表示属于该UUID对应的企业项目。 关于企业项目ID的获取及企业项目特性的详细信息，请参考“企业中心总览”。 __is_offshelved String 表示当前市场镜像是否下架。 true：已下架 false：未下架 hw_firmware_type String 云服务器的启动方式。目前支持： bios：表示bios引导启动。 uefi：表示uefi引导启动。 hw_vif_multiqueue_enabled String 镜像是否支持网卡多队列。取值为“true”或者“false”。 __support_arm String 是否为ARM架构类型的镜像。取值为“true”或者“false”。 __support_agent_list String 镜像是否支持主机安全或主机监控。 hss：主机安全 ces：主机监控 取值样例： "__support_agent_list": "hss,ces" 说明： 如果查询结果无此字段，表示镜像不支持主机安全或主机监控。 __account_code String 收费镜像标识。 __image_location String 镜像的存储位置。 __is_config_init String 是否完成了初始化配置。取值为“true”或者“false”。 __support_amd String 是否是AMD架构类型的镜像。取值为“true”或者“false”。 响应样例 STATUS CODE 200 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 { "schema": "/v2/schemas/image", "min_disk": 100, "created_at": "2018-09-06T14:03:27Z", "__image_source_type": "uds", "container_format": "bare", "file": "/v2/images/bc6bed6e-ba3a-4447-afcc-449174a3eb52/file", "updated_at": "2018-09-06T15:17:33Z", "protected": true, "checksum": "d41d8cd98f00b204e9800998ecf8427e", "id": "bc6bed6e-ba3a-4447-afcc-449174a3eb52", "__isregistered": "true", "min_ram": 2048, "__lazyloading": "true", "owner": "1bed856811654c1cb661a6ca845ebc77", "__os_type": "Linux", "__imagetype": "gold", "visibility": "public", "virtual_env_type": "FusionCompute", "tags": [], "__platform": "CentOS", "size": 0, "__os_bit": "64", "__os_version": "CentOS 7.3 64bit", "name": "CentOS 7.3 64bit vivado", "self": "/v2/images/bc6bed6e-ba3a-4447-afcc-449174a3eb52", "disk_format": "zvhd2", "virtual_size": null, "status": "active" }

鲲鹏系统架构云服务器系列 以下云服务器支持的操作系统请参考表7。 鲲鹏通用计算增强型：kc1 鲲鹏内存优化型：km1 以下云服务器支持的操作系统请参考表8。 鲲鹏通用计算增强型：kc2 鲲鹏内存优化型：km2 鲲鹏超高I/O型云服务器：ki1系列支持CentOS 7.6、Huawei Cloud EulerOS 2.0。 鲲鹏AI推理加速型云服务器：kAi1s系列仅支持CentOS 7.6、Ubuntu 18.04 Server。 表7 OS-支持版本 OS发行版本 支持版本 Huawei Cloud EulerOS Huawei Cloud EulerOS 2.0 标准版 Huawei Cloud EulerOS 2.0 等保2.0三级版 CentOS 64bit：CentOS 8：8.0 64bit：CentOS 7：7.6/7.5/7.4 Ubuntu 64bit：Ubuntu 18.04 Server EulerOS 64bit：EulerOS 2.8 Red Hat 64bit：Red Hat 7：7.6/7.5 SUSE Linux Enterprise 64bit：SLES 12 SP5/SP4 64bit：SLES 15 openSUSE 64bit：openSUSE Leap 15：15.0 Fedora 64bit：Fedora 29 Debian 64bit：Debian 10.2.0 openEuler 64bit：openEuler 20.03 KylinSec 麒麟信安 64bit：KylinSec 3.3 Kylin 银河麒麟 64bit：KylinOS_V10_SP3 64bit：KylinOS_V10_SP2 64bit：KylinOS_V10_SP1 UnionTechOS 统信 64 bit：UnionTechOS Server 20 1050e NeoKylin 中标麒麟 64bit：NeoKylin 7.6 Rocky Linux 64bit：Rocky Linux 8.7 表8 OS-支持版本 OS发行版本 支持版本 Huawei Cloud EulerOS Huawei Cloud EulerOS 2.0 标准版 Huawei Cloud EulerOS 2.0 等保2.0三级版 CentOS 64bit：CentOS 7.6 Debian 64bit：Debian 10.2.0 openEuler 64bit：openEuler 20.03 Kylin 银河麒麟 64bit：KylinOS_V10_SP1

x86系统架构云服务器系列 以下云服务器支持的操作系统请参考表1。 通用入门型：t6 通用计算型：s2、s3、s6、sn3、s7 通用计算增强型：c3、c6、c6s、c6h、c7 内存优化型：m2、m3、m6、m7 高性能计算型：hc2、h3 磁盘增强型：d2、d3、d6 以下云服务器支持的操作系统请参考表2。 通用计算增强型：c3ne 内存优化型：m3ne 以下云服务器支持的操作系统请参考表3。 超大内存型：e3、e6、e7 以下云服务器支持的操作系统请参考表4。 超高I/O型：i3、ir3 以下云服务器支持的操作系统请参考表5。 超高I/O型：i7、ir7 以下云服务器支持的操作系统请参考表6。 通用计算增强型：ac7、ac8 其他GPU加速型实例参考GPU产品说明。 建议您使用操作系统官方发行版本进行系统构建，避免对发行版本进行裁剪及高度定制，以减少问题发生概率。 操作系统发行版本由操作系统厂商进行不定期版本更迭，部分系统版本厂商已停止维护，不再发布问题修复及安全补丁，建议及时关注厂商公告进行系统升级更新，保证您系统的健壮性。 表1 OS-支持版本 OS发行系列 支持版本 Windows Windows Server 2022 Standard/Datacenter Windows Server 2019 Standard/Datacenter Windows Server 2016 Standard/Datacenter Windows Server 2012 R2 Standard/Datacenter Windows Server 2012 Standard/Datacenter Windows Server 2008 R2 Standard/Enterprise/Datacenter/Web Windows Server Core Version 1709 Huawei Cloud EulerOS 64bit：Huawei Cloud EulerOS 2.0 标准版 64bit：Huawei Cloud EulerOS 2.0 等保2.0三级版 64bit：Huawei Cloud EulerOS 1.1 CentOS兼容版 说明： 仅s7/s6/c7/c6s/c6/m7/m6/d6系列云服务器支持Huawei Cloud EulerOS 2.0各版本的操作系统。 仅s6/c6s/c6/m6/d6系列云服务器支持Huawei Cloud EulerOS 1.1 CentOS兼容版操作系统。 Huawei Cloud EulerOS 1.1 CentOS兼容版仅支持新加坡区域。 CentOS 64bit：CentOS 8：8.3/8.2/8.1/8.0 64bit：CentOS 7：7.9/7.8/7.7/7.6/7.5/7.4/7.3/7.2/7.1/7.0 64bit：CentOS 6：6.10/6.9/6.8/6.7/6.6/6.5/6.4/6.3 CentOS Stream 64bit：CentOS Stream 9 64bit：CentOS Stream 8 Ubuntu 64bit：Ubuntu 22.04/20.04/18.04/16.04/14.04/12.04 Server EulerOS 64bit：EulerOS 2.5/2.3/2.2 Red Hat 64bit：Red Hat 8：8.0 64bit：Red Hat 7：7.9/7.8/7.6/7.5/7.4/7.3/7.2/7.1/7.0 64bit：Red Hat 6：6.10/6.9/6.8/6.7/6.6/6.5/6.4 SUSE Linux Enterprise 64bit：SLES 15：15/15 SP1/15 SP2/15 SP3 64bit：SLES 12：12 SP4/12 SP3/12 SP2/12 SP1/12 64bit：SLES 11：11 SP4/11 SP3 Debian 64bit：Debian 11：11.1.0 64bit：Debian 10：10.0.0~10.5.0、10.7.0 64bit：Debian 9：9.13.0/9.12.0/9.11.0/9.9.0/9.8.0/9.7.0/9.6.0/9.5.0/9.4.0/9.3.0/9.0.0 64bit：Debian 8：8.0.0~8.10.0 openSUSE 64bit：openSUSE Leap 42：42.3/42.2/42.1 64bit：openSUSE Leap 15：15.1/15.0 64bit：openSUSE 13：13.2 Fedora 64bit：Fedora 22~32 CoreOS 64bit：CoreOS 2079.4.0 FreeBSD 64bit：FreeBSD 12.1、FreeBSD 11.0、FreeBSD 10.3 openEuler 64bit：openEuler 22.03 64bit：openEuler 20.03 AlmaLinux 64bit：AlmaLinux 9.0 64bit：AlmaLinux 8.4 64bit：AlmaLinux 8.3 Rocky Linux 64bit：Rocky Linux 9.0 64bit：Rocky Linux 8.5 64bit：Rocky Linux 8.4 表2 OS-支持版本 OS发行版本 支持版本 Windows Windows Server 2019 Datacenter Windows Server 2016 Standard/Datacenter Windows Server 2012 R2 Standard/Datacenter Windows Server 2008 R2 Enterprise/Datacenter/Web/Standard Windows Server Version 1709 Datacenter CentOS 64bit： CentOS 8 CentOS 7 CentOS 6 Ubuntu 64bit： Ubuntu 22.04 Server Ubuntu 20.04 Server Ubuntu 18.04 Server Ubuntu 16.04 Server Ubuntu 14.04 Server EulerOS 64bit： EulerOS 2.5 EulerOS 2.3 EulerOS 2.2 Red Hat 64bit： Red Hat 7 Red Hat 6 SUSE Linux Enterprise 64bit： SLES 12 SLES 11 Debian 64bit： Debian 9 Debian 8 openSUSE 64bit： openSUSE 15.1 openSUSE 15.0 Fedora 64bit： Fedora 2x openEuler 64bit： openEuler 20.03 表3 OS-支持版本 OS发行版本 支持版本 Huawei Cloud EulerOS 说明： 仅e6系列云服务器支持此操作系统。 Huawei Cloud EulerOS 2.0 标准版 Huawei Cloud EulerOS 2.0 等保2.0三级版 CentOS 64bit： CentOS 8 CentOS 7 CentOS 6 Ubuntu 64bit： Ubuntu 20.04 Server Ubuntu 18.04 Server Ubuntu 16.04 Server Ubuntu 14.04 Server EulerOS 64bit： EulerOS 2.5 EulerOS 2.3 EulerOS 2.2 Red Hat 64bit： Red Hat 7 Red Hat 6 SUSE Linux Enterprise 64bit： SLES 15 SLES 12 SLES 11 Debian 64bit： Debian 10 Debian 9 Debian 8 openSUSE 64bit： openSUSE 15.1 openSUSE 15.0 Fedora 64bit： Fedora 3x Fedora 2x openEuler 64bit： openEuler 20.03 表4 OS-支持版本 OS发行版本 支持版本 CentOS 64bit： CentOS 7 Ubuntu 64bit： Ubuntu 20.04 Server Ubuntu 18.04 Server Ubuntu 16.04 Server Ubuntu 14.04 Server EulerOS 64bit： EulerOS 2.3 EulerOS 2.2 SUSE Linux Enterprise 64bit： SLES 12 Debian 说明： ir3系列云服务器不支持Debian操作系统。 64bit： Debian 9 Debian 8

计费项 付费实例包含以下计费项。 标 * 的计费项为必选计费项。 表1 计费项说明 计费项 计费单价 计费公式 *实例基础费用（仅付费实例） 0.075元/实例/小时 付费实例基础费用单价*付费实例数量*计费时长 超出存储空间收费 赠送5GB SQL存储空间，超过5GB：0.0072元/GB/小时 超出存储容量单价*超出存储容量(GB)*超出时长 说明： 超出时长：存储数据超过免费赠送存储空间的使用时长。

计费示例 假设您在2023/04/18 8:32:16成功设置了15个付费实例，然后在2023/04/18 11:55:25将其恢复成免费实例，则： 计费周期为8:00:00 ~ 9:00:00，9:00:00 ~ 10:00:00，10:00:00 ~ 11:00:00，11:00:00 ~ 12:00:00，在8:32:16~11:55:25间产生费用，该计费周期内的计费时长为4小时。 图1给出了上述示例付费实例的费用计算过程。 付费实例计费金额如果遇小数点，则保留小数点后两位，第三位四舍五入。如遇四舍五入后不足￥0.01，则按￥0.01展示。 图1 付费实例费用计算示例

超出免费赠送空间对计费的影响 如果您在设置付费实例后存储数据容量超出免费赠送的5GB存储空间，则会增加新的计费项。 例如，您在9:00:00设置一个付费实例，在16:45:00时存储空间超过5GB，那么在在9:00:00 ~ 17:00:00会产生两条计费信息。 第一条对应9:00:00 ~ 17:00:00，按实例基础费用计费。 第二条对应16:00:00 ~ 17:00:00，按超出存储空间计费。

计费周期 付费实例按小时进行计费，每一个小时整点结算一次费用（以UTC+8时间为准），不足一小时按一小时计费，结算完成后进入新的计费周期。计费的起点以设置付费实例成功的时间点为准，终点以恢复成免费实例时间为准。 例如，您在8:45:30成功设置了一个付费实例，然后在10:45:30将其恢复成免费实例，则计费周期为8:00:00 ~ 9:00:00，9:00:00 ~ 10:00:00，10:00:00 ~ 11:00:00，在8:45:30 ~ 10:45:30间产生费用，该计费周期内的计费时长为3小时。

备份管理 GaussDB 支持数据库实例的备份和恢复，以保证数据可靠性。备份目前将以未加密的方式存储，防止客户误操作或者服务异常的情况下，因没有开启备份而造成数据丢失的情况，GaussDB针对备份提供了以下能力： 提供了自动和手动的备份功能，具体内容请参见备份概述，在创建GaussDB实例时，系统默认开启实例级自动备份策略。实例创建成功后，您可根据业务需要修改实例级自动备份策略。 提供了自动备份策略，定时定期对数据库进行备份。具体内容请参见设置自动备份策略。 提供了导出备份文件的能力，具体内容请参见导出备份信息。

WAL 归档配置 WAL(Write Ahead Log)即预写式日志，也称为Xlog 。wal_level决定了写入WAL的信息量。为了在备机上开启只读查询，wal_level需要在主机上设置成hot_standby，并且备机设置hot_standby参数为on。对于分布式环境，不支持设置hot_standby为off，因此wal_level不可设置为archive或minimal，否则数据库将无法启动。建议设置wal_level参数为默认值hot_standby。

安全认证配置 为了保证用户体验，同时为了防止账户被人通过暴力破解，GaussDB设置了账户登录重试次数及失败后自动解锁时间的保护措施，GaussDB针对账户提供了以下能力： failed_login_attempts：允许用户设置最大登录失败次数。 password_lock_time：此参数允许用户修改账户被锁定后自动解锁时间，单位为天。 若管理员发现某账户被盗、非法访问等异常情况，可手动锁定该账户。当管理员认为账户恢复正常后，可手动解锁该账户。 以手动锁定和解锁用户joe为例，命令格式如下： 手动锁定 1 2 gaussdb=# ALTER USER joe ACCOUNT LOCK; ALTER ROLE 手动解锁 1 2 gaussdb=# ALTER USER joe ACCOUNT UNLOCK; ALTER ROLE

最大连接数配置 如果GaussDB连接数过高，会消耗服务器大量资源，导致操作响应变慢，参考以下几个参数进行优化，具体内容请参见连接设置： max_connections：允许和数据库连接的最大并发连接数，此参数会影响集群的并发能力。 max_inner_tool_connections：允许和数据库连接的工具的最大并发连接数，此参数会影响GaussDB的工具连接并发能力。 sysadmin_reserved_connections：为管理员用户预留的最少连接数，不建议设置过大。该参数和max_connections参数配合使用，管理员用户的最大连接数等于max_connections + sysadmin_reserved_connections。 该参数属于POSTMASTER类型参数，具体内容请参见设置参数中对应设置方法进行设置。

用户密码的安全策略 GaussDB为了客户账号的安全，GaussDB对用户密码进行了以下设置： 用户密码存储在系统表pg_authid中，为防止用户密码泄露，GaussDB对用户密码进行加密存储，所采用的加密算法由配置参数password_encryption_type决定。 GaussDB数据库 用户的密码都有密码有效期，可以通过参数password_notify_time提醒客户修改密码，如果需要修改密码有效期，可以通过修改password_effect_time来更改。

ADM_USERS ADM_USERS视图显示所有数据库用户的信息。默认只有系统管理员权限才可以访问。该视图同时存在于PG_CATA LOG 和SYS Schema下。 表1 ADM_USERS字段 名称 类型 描述 username character varying(128) 用户名称。 user_id oid 用户ID。 account_status character varying(32) 账户状态。 NULL：该账户是拥有最高权限的初始系统管理员。 0：正常状态。 1：由于登录失败次数超过阈值被锁定了一定的时间。 2：被管理员锁定。 lock_date timestamp with time zone 默认显示账户的创建日期，如果账户被管理员锁定，或者登录失败次数超过阈值被锁定，则显示账户被锁定的日期。初始系统管理员该字段为NULL。 expiry_date timestamp with time zone 账户到期日期。 default_tablespace character varying(4000) 数据的默认表空间。 temporary_tablespace character varying(4000) 临时表的默认表空间的名称或表空间组的名称。 local_temp_tablespace character varying(30) 暂不支持，默认值为NULL。 created timestamp with time zone 用户创建日期。 profile character varying(128) 暂不支持，默认值为NULL。 initial_rsrc_consumer_group character varying(128) 暂不支持，默认值为NULL。 external_name character varying(4000) 暂不支持，默认值为NULL。 password_versions character varying(12) 显示账户密码的加密方式。取值为：MD5、SHA256或SM3。 editions_enabled character varying(1) 暂不支持，默认值为NULL。 authentication_type text 用户的身份验证机制。 proxy_only_connect character varying(1) 暂不支持，默认值为NULL。 common character varying(3) 暂不支持，默认值为NULL。 last_login timestamp with time zone 用户最后一次登录的时间。 oracle_maintained character varying(1) 暂不支持，默认值为NULL。 inherited character varying(3) 暂不支持，默认值为NULL。 default_collation character varying(100) 用户Schema的默认字符序。 implicit character varying(3) 暂不支持，默认值为NULL。 all_shard character varying(3) 暂不支持，默认值为NULL。 password_change_date timestamp with time zone 上次设置用户密码的日期。 父主题： 用户和权限管理

参数说明 pdb_name PDB名称。 取值范围：字符串，要符合标识符命名规范。 OPEN 打开指定的PDB。PDB的OPEN操作对其数据库实例的启动，即仅当PDB开启时才提供服务。管理员可按需启用或停用一部分PDB。只有PDB处于开启状态时，才允许被连接。 CLOSE 关闭指定的PDB。当用户暂不需要使用PDB或者需要将其删除时，可以通过CLOSE操作停止PDB的服务。关闭后，无法连接到该PDB。数据库会对关闭的PDB进行最基本的常规维护，以保证系统整体的一致性。这些停用的PDB对系统开销可以忽略。如果执行该语句时，该PDB还存在业务连接，则将最多等待5秒，后续还存在则会导致关闭失败。 注：只有在当前的资源计划中存在与PDB关联的资源计划指令时，才可以成功打开PDB。 CLOSE IMMEDIATE 强制关闭指定的PDB。如果管理员无法主动断连PDB的业务连接，可以使用该选项主动清退PDB现有的业务连接，并关闭PDB。

注意事项 只能在GUC参数enable_mtd为on的状态下使用。 只能在非PDB中进行该操作。不可在M兼容数据库中执行该命令。 操作用户需要为PDB属主（见系统表pg_database.datdba）或拥有sysadmin权限。 仅数据库初始用户可以使用该语句变更模板PDB（template_pdb）。 模板PDB只允许数据库初始用户连接，其他用户无法连接。 禁止用户在模板PDB下执行任何数据操作，若执行相关操作，可能产生预期外行为。例如，若在模板PDB内创建表空间，后续基于该模板创建的PDB不会同步模板内的表空间软链接，表空间软链接会发生丢失。

DB_INDEXES DB_INDEXES视图显示当前用户可访问的索引信息。该视图同时存在于PG_CATALOG和SYS Schema下。 表1 DB_INDEXES字段 名称 类型 描述 owner character varying(64) 索引的所有者。 index_name character varying(64) 索引名称。 table_name character varying(64) 索引对应的表名。 uniqueness text 表示该索引是否为唯一索引。 UNIQUE：唯一索引。 NONUNIQUE：非唯一索引。 partitioned character(3) 表示该索引是否具有分区表的性质。 Yes：索引具有分区表的性质。 No：索引不具有分区表的性质。 generated character varying(1) 表示该索引的名称是否为系统生成。 y：索引名称为系统生成。 n：索引名称非系统生成。 index_type character varying(27) 索引类型。 NORMAL：索引属性都是简单引用，表达式树为空。 FUNCTION-BASED NORMAL：存在表达式树用于非简单字段引用的索引属性。 table_owner character varying(128) 索引对象的所有者。 table_type character(11) 索引对象的类型。 TABLE：索引对象为表类型。 tablespace_name character varying(30) 包含索引的表空间名称。 status character varying(8) 非分区索引状态。 VALID：非分区索引可以用于查询。 UNUSABLE：非分区索引不可用。 N/A：索引具有分区表性质。 compression character varying(13) 暂不支持，值为NULL。 prefix_length numeric 暂不支持，值为NULL。 ini_trans numeric 暂不支持，值为NULL。 max_trans numeric 暂不支持，值为NULL。 initial_extent numeric 暂不支持，值为NULL。 next_extent numeric 暂不支持，值为NULL。 min_extents numeric 暂不支持，值为NULL。 max_extents numeric 暂不支持，值为NULL。 pct_increase numeric 暂不支持，值为NULL。 pct_threshold numeric 暂不支持，值为NULL。 include_column numeric 暂不支持，值为NULL。 freelists numeric 暂不支持，值为NULL。 freelist_groups numeric 暂不支持，值为NULL。 pct_free numeric 暂不支持，值为NULL。 logging character varying(3) 暂不支持，值为NULL。 blevel numeric 暂不支持，值为NULL。 leaf_blocks numeric 暂不支持，值为NULL。 distinct_keys numeric 暂不支持，值为NULL。 avg_leaf_blocks_per_key numeric 暂不支持，值为NULL。 avg_data_blocks_per_key numeric 暂不支持，值为NULL。 clustering_factor numeric 暂不支持，值为NULL。 num_rows numeric 暂不支持，值为NULL。 sample_size numeric 暂不支持，值为NULL。 last_analyzed timestamp(0) without time zone 暂不支持，值为NULL。 degree character varying(40) 暂不支持，值为NULL。 instances character varying(40) 暂不支持，值为NULL。 temporary character varying(1) 暂不支持，值为NULL。 secondary character varying(1) 暂不支持，值为NULL。 buffer_pool character varying(7) 暂不支持，值为NULL。 flash_cache character varying(7) 暂不支持，值为NULL。 cell_flash_cache character varying(7) 暂不支持，值为NULL。 user_stats character varying(3) 暂不支持，值为NULL。 duration character varying(15) 暂不支持，值为NULL。 pct_direct_access numeric 暂不支持，值为NULL。 ityp_owner character varying(128) 暂不支持，值为NULL。 ityp_name character varying(128) 暂不支持，值为NULL。 parameters character varying(1000) 暂不支持，值为NULL。 global_stats character varying(3) 暂不支持，值为NULL。 domidx_status character varying(12) 暂不支持，值为NULL。 domidx_opstatus character varying(6) 暂不支持，值为NULL。 funcidx_status character varying(8) 暂不支持，值为NULL。 join_index character varying(3) 暂不支持，值为NULL。 iot_redundant_pkey_elim character varying(3) 暂不支持，值为NULL。 dropped character varying(3) 暂不支持，值为NULL。 visibility character varying(9) 表示该索引对优化器是否可见。 VISIBLE：索引对优化器可见。 INVISIBLE：索引对优化器不可见。 domidx_management character varying(14) 暂不支持，值为NULL。 segment_created character varying(3) 暂不支持，值为NULL。 orphaned_entries character varying(3) 暂不支持，值为NULL。 indexing character varying(7) 暂不支持，值为NULL。 auto character varying(3) 暂不支持，值为NULL。 父主题： 其他系统视图