华为云用户手册

PG_CONSTRAINT PG_CONSTRAINT系统表存储表上的检查约束、主键、唯一约束和外键约束。 表1 PG_CONSTRAINT字段 名称 类型 描述 conname name 约束名称（不一定是唯一的）。 connamespace oid 包含约束的命名空间的OID。 contype "char" c = 检查约束 f = 外键约束 p = 主键约束 u = 唯一约束 t = 触发器约束 condeferrable boolean 该约束是否可以推迟。 condeferred boolean 缺省时该约束是否可以推迟。 convalidated boolean 约束是否有效。目前，只有外键和CHECK约束可将其设置为FALSE。 conrelid oid 该约束所在的表；如果不是表约束则为0。 contypid oid 该约束所在的域；如果不是一个域约束则为0。 conindid oid 与约束关联的索引ID。 confrelid oid 如果是外键，则为参考的表；否则为0。 confupdtype "char" 外键更新动作代码。 a = 没动作 r = 限制 c = 级联 n =设置为null d =设置为缺省 confdeltype "char" 外键删除动作代码。 a = 没动作 r = 限制 c = 级联 n =设置为null d =设置为缺省 confmatchtype "char" 外键匹配类型。 f = 全部 p = 部分 u = 简单（未指定） conislocal boolean 是否是为关系创建的本地约束。 coninhcount integer 约束直接继承父表的数目。继承父表数非零时，不能删除或重命名该约束。 connoinherit boolean 是否可以被继承。 consoft boolean 是否为信息约束(Informational Constraint)。 conopt boolean 是否使用信息约束优化执行计划。 conkey smallint[] 如果是表约束，则是约束控制的字段列表。 confkey smallint[] 如果是一个外键，则是参考的字段的列表。 conpfeqop oid[] 如果是一个外键，是做PK=FK比较的相等操作符ID的列表。 conppeqop oid[] 如果是一个外键，是做PK=PK比较的相等操作符ID的列表。 conffeqop oid[] 如果是一个外键，是做FK=FK比较的相等操作符ID的列表。 conexclop oid[] 如果是一个排他约束，是列的排他操作符ID列表。 conbin pg_node_tree 如果是检查约束，则是其表达式的内部形式。 consrc text 如果是检查约束，则是表达式的人类可读形式。 当被引用的对象改变时，consrc不能被更新。例如，它不会跟踪字段的重命名。最好还是使用pg_get_constraintdef()来抽取一个检查约束的定义，而不是依赖这个字段。 pg_class.relchecks需要和每个关系在此目录中的检查约束数量保持一致。 父主题： 系统表

PG_PARTITION PG_PARTITION系统表存储数据库内所有分区表(partitioned table)、分区(table partition)、分区上toast表和分区索引(index partition)四类对象的信息。分区表索引(partitioned index)的信息不在PG_PARTITION系统表中保存。 表1 PG_PARTITION字段 名称 类型 描述 relname name 分区表、分区、分区上toast表和分区索引的名称。 parttype "char" 对象类型： 'r'：partitioned table 'p'：table partition 'x'：index partition 't'：toast table parentid oid 当对象为分区表或分区时，此字段表示分区表在PG_CLASS中的OID。 当对象为index partition时，此字段表示所属分区表索引(partitioned index)的OID。 rangenum integer 保留字段。 intervalnum integer 保留字段。 partstrategy "char" 分区表分区策略，现在仅支持： 'r'：范围分区。 'v'：数值分区。 'l'：列表分区。 relfilenode oid table partition、index partition、分区上toast表的物理存储位置。 reltablespace oid table partition、index partition、分区上toast表所属表空间的OID。 relpages double precision 统计信息：table partition、index partition的数据页数量。 reltuples double precision 统计信息：table partition、index partition的元组数。 relallvisible integer 统计信息：table partition、index partition的可见数据页数。 reltoastrelid oid table partition所对应toast表的OID。 reltoastidxid oid table partition所对应toast表的索引的OID。 indextblid oid index partition对应table partition的OID。 indisusable boolean 分区索引是否可用。 reldeltarelid oid Delta表的OID。 reldeltaidx oid Delta表的索引表的OID。 relcudescrelid oid CU描述表的OID。 relcudescidx oid CU描述表的索引表的OID。 relfrozenxid xid32 冻结事务ID号。 为保持前向兼容，保留此字段，新增relfrozenxid64用于记录此信息。 intspnum integer 间隔分区所属表空间的个数。 partkey int2vector 分区键的列号。 intervaltablespace oidvector 间隔分区所属的表空间，间隔分区以round-robin方式落在这些表空间内。 interval text[] 间隔分区的间隔值。 boundaries text[] 范围分区和间隔分区的上边界。 transit text[] 间隔分区的跳转点。 reloptions text[] 设置partition的存储属性，与pg_class.reloptions的形态一样，用"keyword=value"格式的字符串来表示 ，目前用于在线扩容的信息搜集。 relfrozenxid64 xid 冻结事务ID号。 boundexprs pg_node_tree 分区边界表达式。 对于范围分区来说是分区上边界表达式。 对于列表分区来说是分区边界枚举值集合。 pg_node_tree数据类型是不可读的，可用如下表达式pg_get_expr把当前字段单翻译为可读信息。 1 2 3 4 5 6 SELECT pg_get_expr(boundexprs, 0) FROM pg_partition WHERE relname = 'country_202201'; pg_get_expr --------------------------------------------------------------- ROW(202201, 'city1'::text), ROW(202201, 'city2'::text) (1 row) relmetaversion xid 元数据版本信息，该字段仅云原生3.0版本支持。 父主题： 系统表

PG_NAMESPACE PG_NAMESPACE系统表存储命名空间，即存储schema相关的信息。云原生数仓3.0版本新增nsptype字段，用于区分external schema和普通schema。external schema对应的值为'e'，普通schema对应的值为'i'。 表1 PG_NAMESPACE字段 名称 类型 描述 nspname name 命名空间的名称。 nspowner oid 命名空间的所有者。 nsptimeline bigint 在DN上创建此命名空间时的时间线。此字段为内部使用，仅在DN上有效。 nspacl aclitem[] 访问权限。具体请参见GRANT和REVOKE。 permspace bigint schema永久表空间限额。 usedspace bigint schema已用永久表空间大小。 nsptype char 区分external schema和普通schema。 父主题： 系统表

示例 查询文件缓存所使用的硬盘的信息： select * from pgxc_disk_cache_path_info order by 1; path_name | node_name | cache_size | disk_available | disk_size | disk_use_ratio ----------------+--------------+------------+----------------+--------------+------------------ dn_6001_6002_0 | dn_6001_6002 | 19619 | 137401716736 | 160982630400 | .146481105479564 dn_6001_6002_1 | dn_6001_6002 | 35968 | 137401716736 | 160982630400 | .146481105479564 dn_6003_6004_0 | dn_6003_6004 | 27794 | 121600655360 | 160982630400 | .244634933235629 dn_6003_6004_1 | dn_6003_6004 | 26158 | 121600655360 | 160982630400 | .244634933235629 dn_6005_6006_0 | dn_6005_6006 | 24533 | 134394839040 | 160982630400 | .165159379579873 dn_6005_6006_1 | dn_6005_6006 | 31065 | 134394839040 | 160982630400 | .165159379579873

PG_TRIGGER PG_TRIGGER系统表存储触发器信息。 名称 类型 描述 tgrelid oid 触发器所在表的OID。 tgname name 触发器名。 tgfoid oid 触发器OID。 tgtype smallint 触发器类型。 tgenabled "char" O表示触发器在“origin”和“local”模式下触发。 D表示触发器被禁用。 R表示触发器在“replica”模式下触发。 A表示触发器始终触发。 tgisinternal boolean 内部触发器标识，如果为true表示内部触发器。 tgconstrrelid oid 完整性约束引用的表。 tgconstrindid oid 完整性约束的索引。 tgconstraint oid 约束触发器在pg_constraint中的OID。 tgdeferrable boolean 约束触发器是为DEFERRABLE类型。 tginitdeferred boolean 约束触发器是否为INITIALLY DEFERRED类型。 tgnargs smallint 触发器函数入参个数。 tgattr int2vector 当触发器指定列时的列号，未指定则为空数组。 tgargs bytea 传递给触发器的参数。 tgqual pg_node_tree 表示触发器的WHEN条件，如果没有则为null。 父主题： 系统表

响应示例 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 { "interfaceAttachments": [ { "port_state": "ACTIVE", "fixed_ips": [ { "subnet_id": "f8a6e8f8-c2ec-497c-9f23-da9616de54ef", "ip_address": "192.168.1.3" } ], "net_id": "3cb9bc59-5699-4588-a4b1-b87f96708bc6", "port_id": "ce531f90-199f-48c0-816c-13e38010b442", "mac_addr": "fa:16:3e:4c:2c:30" } ] }

响应参数 参数 参数类型 描述 interfaceAttachments Array of objects 裸金属服务器网卡信息列表。详情请参见表2。 表2 interfaceAttachments字段数据结构说明 参数 参数类型 描述 port_state String 网卡端口状态，取值为：ACTIVE、BUILD、DOWN。 fixed_ips Array of objects 网卡私网IP信息列表。详情请参见表3。 net_id String 网卡端口所属子网的网络ID（network_id）。 port_id String 网卡端口ID。 mac_addr String 网卡MAC地址信息。 表3 fixed_ips字段数据结构说明 参数 参数类型 描述 subnet_id String 网卡私网IP对应子网的子网ID（subnet_id）。 ip_address String 网卡私网IP信息。

请求示例 强制重启ID为95bf2490-5428-432c-ad9b-5e3406f869dd的裸金属服务器。 1 POST https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/action 1 2 3 4 5 { "reboot": { "type": "HARD" } }

URI GET /v2.1/{project_id}/servers/{server_id}/os-volume_attachments 参数说明请参见表1。 表1 参数说明 参数 是否必选 描述 project_id 是 项目ID。 获取方式请参见获取项目ID。 server_id 是 裸金属服务器ID。 可以从裸金属服务器控制台查询，或者通过调用查询裸金属服务器列表（OpenStack原生）获取。

响应示例 1 2 3 4 5 6 7 8 { "volumeAttachments": { "device": "/dev/vdb", "serverId": "820abbd0-2d8e-4bc5-ae46-69cacfd4fbaa", "id": "b53f23bd-ee8f-49ec-9420-d1acfeaf91d6", "volumeId": "b53f23bd-ee8f-49ec-9420-d1acfeaf91d6" } }

响应参数 参数 参数类型 描述 volumeAttachments Object 裸金属服务器挂载信息列表，详情请参见表2。 表2 volumeAttachments字段数据结构说明 参数 参数类型 描述 device String 挂载目录，例如“/dev/vdb”。 id String 挂载资源ID。 serverId String 所属裸金属服务器ID。 volumeId String 挂载云硬盘ID。

响应示例 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 { "extra_specs": { "capabilities:cpu_arch": "x86_64", "baremetal:disk_detail": "SAS 8T", "capabilities:hypervisor_type": "ironic", "baremetal:__support_evs": "true", "baremetal:extBootType": "LocalDisk", "capabilities:board_type": "s2m", "baremetal:net_num": "2", "baremetal:netcard_detail": "2*10GE", "baremetal:cpu_detail": "2*8coreIntel Xeon E5-2667 V43.2GHz", "resource_type": "ironic", "baremetal:memory_detail": "256GB DDR4 RAM(GB)" } }

响应参数 参数 参数类型 描述 extra_specs Object 描述裸金属服务器规格的键值对。 capabilities:cpu_arch：裸金属服务器的CPU架构，取值为x86_64（适用于x86机型）或aarch64（适用于ARM机型） baremetal:disk_detail：磁盘的描述信息。 capabilities:hypervisor_type：hypervisor类型，固定为“ironic”。 baremetal:__support_evs：是否支持云硬盘，取值为true或false。如果裸金属服务器规格中没有此参数，表示不支持云硬盘。 baremetal:extBootType：表示裸金属服务器的启动源，取值为LocalDisk（表示本地盘）或Volume（表示云硬盘，即快速发放） baremetal:net_num：裸金属服务器实际可绑定的网卡数量。 baremetal:netcard_detail：网卡的描述信息。 baremetal:cpu_detail：CPU的描述信息。 resource_type：资源类型，固定为“ironic”。 baremetal:memory_detail：内存的描述信息。

响应参数 正常响应要素 表4 正常响应要素说明 名称 参数类型 说明 job_id String 提交任务成功后返回的任务ID，用户可以使用该ID对任务执行情况进行查询。 如何根据job_id来查询Job的执行状态，请参考查询Job状态。 异常响应要素 表5 异常响应要素说明 名称 参数类型 说明 error 字典数据结构 提交任务异常时返回的异常信息，详情请参见表6。 表6 error数据结构 名称 参数类型 说明 message String 任务异常错误信息描述。 code String 任务异常错误信息编码。

请求参数 关闭裸金属服务器请求参数，必须如请求示例中，以“os-stop”字段下发关闭裸金属服务器请求。 参数 是否必选 参数类型 描述 os-stop 是 Object 标记为关闭裸金属服务器操作，详情请参见表2。 表2 os-stop字段数据结构说明 参数 是否必选 参数类型 描述 servers 是 Array of objects 裸金属服务器ID列表，详情请参见表3。 type 否 String 关机类型： SOFT：普通关机（不生效）。 HARD：强制关机（默认）。 表3 servers字段数据结构说明 参数 是否必选 参数类型 描述 id 是 String 裸金属服务器ID。 可以从裸金属服务器控制台查询，或者通过调用查询裸金属服务器列表（OpenStack原生）获取。

请求示例 强制关闭ID为616fb98f-46ca-475e-917e-2563e5a8cd19和726fb98f-46ca-475e-917e-2563e5a8cd20的裸金属服务器。 1 POST https://{BMS Endpoint}/v1/bbf1946d374b44a0a2a95533562ba954/baremetalservers/action 1 2 3 4 5 6 7 8 9 10 11 12 13 { "os-stop": { "type": "HARD", "servers": [ { "id": "616fb98f-46ca-475e-917e-2563e5a8cd19" }, { "id": "726fb98f-46ca-475e-917e-2563e5a8cd20" } ] } }

URI POST /v1/{project_id}/baremetalservers/{server_id}/nics/delete 参数说明请参见表1。 表1 参数说明 参数 是否必选 描述 project_id 是 项目ID。 获取方式请参见获取项目ID。 server_id 是 裸金属服务器ID。 可以从裸金属服务器控制台查询，或者通过调用查询裸金属服务器列表（OpenStack原生）获取。

响应参数 表4 正常响应要素说明 名称 参数类型 说明 job_id String 提交任务成功后返回的任务ID，用户可以使用该ID对任务执行情况进行查询。 如何根据job_id来查询Job的执行状态，请参考查询Job状态。 表5 异常响应要素说明 名称 参数类型 说明 error 字典数据结构 提交任务异常时返回的异常信息，详情请参见表6。 表6 error数据结构 名称 参数类型 说明 message String 任务异常错误信息描述。 code String 任务异常错误信息编码。

请求示例 更新ID为cf2a8b97-b5c6-47ef-9714-eb27adf26e5b的裸金属服务器的元数据，自定义metadata键值对为key和value。 1 POST https://{BMS Endpoint}/v1/bbf1946d374b44a0a2a95533562ba954/baremetalservers/cf2a8b97-b5c6-47ef-9714-eb27adf26e5b/metadata 1 2 3 4 5 { "metadata": { "key": "value" } }

请求示例 批量添加标签，标签键值对为key1和value1，key2和value3。 { "action": "create", "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value3" } ] }

响应示例 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 { "volumeAttachments": [ { "device": "/dev/sdd", "id": "a26887c6-c47b-4654-abb5-dfadf7d3f803", "serverId": "4d8c3732-a248-40ed-bebc-539a6ffd25c0", "volumeId": "a26887c6-c47b-4654-abb5-dfadf7d3f803" }, { "device": "/dev/sdc", "id": "a26887c6-c47b-4654-abb5-dfadf7d3f804", "serverId": "4d8c3732-a248-40ed-bebc-539a6ffd25c0", "volumeId": "a26887c6-c47b-4654-abb5-dfadf7d3f804" } ] }

请求示例 查询ID为4d8c3732-a248-40ed-bebc-539a6ffd25c0的裸金属服务器上挂载的云硬盘信息。 1 GET https://{BMS Endpoint}/v1/bbf1946d374b44a0a2a95533562ba954/baremetalservers/4d8c3732-a248-40ed-bebc-539a6ffd25c0/os-volume_attachments

响应参数 参数 参数类型 描述 volumeAttachments Array of objects 裸金属服务器挂载信息列表，详情请参见表2。 表2 volumeAttachments字段数据结构说明 参数 参数类型 描述 device String 挂载目录，例如“/dev/sdd”。 id String 挂载资源ID。 serverId String 所属裸金属服务器ID。 volumeId String 挂载云磁盘ID。

URI GET /v1/{project_id}/baremetalservers/{server_id}/os-volume_attachments 参数说明请参见表1。 表1 参数说明 参数 是否必选 描述 project_id 是 项目ID。 获取方式请参见获取项目ID。 server_id 是 裸金属服务器ID。 可以从裸金属服务器控制台查询，或者通过调用查询裸金属服务器列表（OpenStack原生）获取。

请求示例 查询裸金属服务器列表。 1 GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers 查询标签中包含__type_baremetal的裸金属服务器列表。 1 GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers?tags=__type_baremetal 查询标签中包含__type_baremetal且名称包含bms-test01的裸金属服务器列表。 1 GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers?tags=__type_baremetal&name=bms-test01

响应示例 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 { "servers": [ { "name": "bms", "links": [ { "rel": "self", "href": "https://openstack.example.com/v2.1/c685484a8cc2416b97260938705deb65/servers/820abbd0-2d8b-4bc5-ae46-69cacfd4fbaa" }, { "rel": "bookmark", "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/servers/820abbd0-2d8e-4bc5-ae46-69cacfd4fbaa" } ], "id": "820abbd0-2d8e-4bc5-ae46-69cacfd4fbaa" } ] }

响应参数 参数 参数类型 描述 servers Array of objects 裸金属服务器信息列表。详情请参见表2。 表2 servers字段数据结构说明 参数 参数类型 描述 name String 裸金属服务器名称。 id String 裸金属服务器唯一标识。 links Array of objects 裸金属服务器相关快捷链接信息。详情请参见表3。 表3 links字段数据结构说明 参数 参数类型 描述 rel String 快捷链接标记名称。取值为： self：包含版本号的资源链接，需要立即跟踪时使用此类链接。 bookmark：提供了适合长期存储的资源链接。 href String 对应快捷链接。

URI GET /v2.1/{project_id}/servers{?changes-since={changes-since}&image={image}&flavor={flavor}&name={name}&status={status}&limit={limit}&marker={marker}&tags={tags}¬-tags={not-tags}&reservation_id={reservation_id}&sort_key={sort_key}&sort_dir={sort_dir}} 参数说明请参见表1。 表1 参数说明 参数 是否必选 描述 project_id 是 项目ID。 获取方式请参见获取项目ID。

请求参数 参数 是否必选 参数类型 描述 changes-since 否 String 裸金属服务器上次更新状态的时间戳信息。格式为ISO 8601时间格式，例如：2013-06-09T06:42:18Z。 image 否 String 镜像ID。 可以在镜像服务控制台查询，也可以调用“查询镜像列表”API获取。 说明： 在使用image作为条件过滤时，不能同时支持其他过滤条件和分页条件。如果同时指定image及其他条件，则以image条件为准；当条件不含image时，接口功能不受限制。 flavor 否 String 规格ID。 可以在裸金属服务器控制台查询，也可以调用查询裸金属服务器规格信息列表（OpenStack原生）API获取。 name 否 String 裸金属服务器名称，使用模糊匹配的方式查询。 例如，“?name=bob”正则表达式会同时返回bob和bobb。如果必须仅匹配bob，则可以使用与基础数据库服务器的语法相匹配的正则表达式，如MySQL或PostgreSQL（官方网站：https://www.postgresql.org/docs/9.2/static/functions-matching.html）。 status 否 String 裸金属服务器状态。 取值范围： ACTIVE：运行中/正在关机/删除中 BUILD：创建中 ERROR：故障 HARD_REBOOT：强制重启中 REBOOT：重启中 SHUTOFF：关机/正在开机/删除中/重建中/重装操作系统中/重装操作系统失败/冻结 limit 否 Integer 每页返回裸金属服务器的条数。 marker 否 String 从marker指定的裸金属服务器ID的下一条数据开始查询。 tags 否 String 查询tag字段中包含该值的裸金属服务器。 微版本2.26新增 not-tags 否 String 查询tag字段中不包含该值的裸金属服务器，值为标签的Key。 说明： 如果之前添加的Tag为“Key.Value”的形式，则查询的时候需要使用“Key”来查询。 例如：之前添加的tag为“a.b”,则升级后，查询时需使用“not-tags=a”。 微版本2.26新增 reservation_id 否 String 批量创建裸金属服务器时，指定该预留ID，可以查询同批次创建的裸金属服务器。 微版本2.26新增 sort_key 否 String 用于排序的属性，包括uuid（裸金属服务器的uuid）、vm_state（裸金属服务器的状态）、display_name（裸金属服务器名称）、task_state（裸金属服务器任务状态）、power_state（电源状态）、created_at（创建时间）、updated_at（更新时间）、availability_zone（可用区）。可以指定多对sort_key和sort_dir。 默认排序顺序为created_at逆序。 sort_dir 否 String 排序方向。 asc：升序 desc：降序（默认值）

URI POST /v1/{project_id}/baremetalservers/{server_id}/attachvolume 参数说明请参见表1。 表1 参数说明 参数 是否必选 描述 project_id 是 项目ID。 获取方式请参见获取项目ID。 server_id 是 裸金属服务器ID。 可以从裸金属服务器控制台查询，或者通过调用查询裸金属服务器列表（OpenStack原生）获取。