华为云用户手册

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 resources Array of DedicatedResource objects 专属资源池信息 total_count Integer 专属资源池数量 表5 DedicatedResource 参数 参数类型 描述 id String 专属资源池ID。 resource_name String 专属资源池名称 engine_name String 数据库引擎名称 architecture String CPU架构 status String 专属资源池状态 枚举值： NORMAL BUILDING EXTENDING DELETED capacity DedicatedResourceCapacity object 专属资源池容量信息 availability_zone Array of strings 专属资源池可用区信息。 表6 DedicatedResourceCapacity 参数 参数类型 描述 ram Integer 内存大小，单位GB volume Long 磁盘容量，单位GB vcpus Integer cpu核数 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

URI GET /v3/{project_id}/instances/{instance_id}/databases 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String 实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 limit 否 Integer 查询记录数。默认为100，不能为负数，最小值为1，最大值为100。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 databases Array of ListGaussMysqlDatabaseInfo objects 数据库信息列表。 total_count Integer 数据库总数。 表5 ListGaussMysqlDatabaseInfo 参数 参数类型 描述 name String 数据库名称。 charset String 数据库使用的字符集，如utf8mb4、gbk等。 comment String 数据库备注。 users Array of GaussMySqlDatabaseInfo objects 已授权数据库用户列表。 表6 GaussMySqlDatabaseInfo 参数 参数类型 描述 name String 数据库用户名。 host String 主机地址。 readonly Boolean 是否为只读权限： true，表示只读。 false，表示可读写。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

响应示例 状态码： 200 Success. { "databases" : [ { "name" : "test", "charset" : "utf8mb4", "comment" : "database_comment", "users" : [ { "name" : "gaussdb_mysql_user1", "host" : "127.0.0.1", "readonly" : false } ] } ], "total_count" : 1}

响应示例 状态码： 200 Success. { "total_count" : 1, "configurations" : [ { "id" : "887ea0d1bb0843c49e8d8e5a09a95652pr07", "name" : "configuration_test", "description" : "configuration_test", "datastore_version_name" : "8.0", "datastore_name" : "GaussDB(for MySQL)", "created" : "2019-05-15T11:53:34+0000", "updated" : "2019-05-15T11:53:34+0000", "user_defined" : true }, { "id" : "3bc1e9cc0d34404b9225ed7a58fb284epr07", "name" : "Default-GaussDBforMySQL", "description" : "Default parameter template for GaussDBforMySQL", "datastore_version_name" : "8.0", "datastore_name" : "GaussDB(for MySQL)", "created" : "2019-05-27T03:38:51+0000", "updated" : "2019-05-27T03:38:51+0000", "user_defined" : false } ]}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 configurations Array of ConfigurationSummary objects 参数模板信息。 total_count Integer 参数模板的总数。 表5 ConfigurationSummary 参数 参数类型 描述 id String 参数组ID。 name String 参数组名称。 description String 参数组描述。 datastore_version_name String 引擎版本。 datastore_name String 引擎名。 created String 创建时间，格式为"yyyy-MM-ddTHH:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 updated String 更新时间，格式为"yyyy-MM-ddTHH:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 user_defined Boolean 是否是用户自定义参数模板： false，表示为系统默认参数模板。 true，表示为用户自定义参数模板。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

URI GET /v3/{project_id}/configurations 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 limit 否 Integer 查询记录数。默认为100，不能为负数，最小值为1，最大值为100。

响应参数 状态码： 201 表4 响应Body参数 参数 参数类型 描述 job_id String 任务ID。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 X-Language 否 String 语言。 表3 请求Body参数 参数 是否必选 参数类型 描述 node_num 是 Integer proxy节点扩容操作需要扩容的节点数。本次扩容的节点数的取值范围：1~30之间的整数。 限制条件：该实例的proxy节点的总数量小于等于32。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 error_log_list Array of LtsLogErrorDetail objects 错误日志列表。 表5 LtsLogErrorDetail 参数 参数类型 描述 node_id String 节点ID。 time String 执行时间。 level String 日志级别。 content String 错误日志内容。 line_num String 日志单行序列号。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 X-Language 否 String 语言。 表3 请求Body参数 参数 是否必选 参数类型 描述 node_id 是 String 节点ID。 start_time 是 String 开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 end_time 是 String 结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 limit 是 Integer 查询记录数。 line_num 否 String 日志单行序列号，第一次查询时不需要此参数，后续分页查询时需要使用，可从上次查询的返回信息中获取。 level 否 String 日志级别，默认为ALL。 取值范围： ALL INFO LOG WARNING ERROR FATAL PANIC NOTE

请求示例 查询错误日志详细信息。 POST https://{endpoint}/v3.1/056538411200d4cd2f79c003c7606412/instances/096c0fc43e804757b59946b80dc27f8bin07/error-logs{ "start_time" : "2022-11-20T00:00:00+0800", "end_time" : "2022-11-29T00:00:00+0800", "node_id" : "cc07c60e94ec4575989840e648fb4f66no07", "limit" : 10, "line_num" : 1669344916000}

响应示例 状态码： 200 Success. { "error_log_list" : [ { "node_id" : "cc07c60e94ec4575989840e648fb4f66no07", "time" : "2022-11-25T10:55:16.000", "level" : "ERROR", "content" : "[MY013508] [Repl] do failed: 1", "line_num" : 1669344916000 } ]}

URI PUT /v1.0/{project_id}/dedicated-hosts/{dedicated_host_id} 参数说明请参见表1。 表1 参数说明 参数 参数类型 是否必选 描述 project_id String 是 项目ID。 获取方式请参见获取项目ID。 dedicated_host_id String 是 专属主机ID。 可以从专属主机控制台查询，或者通过调用查询专属主机列表API获取。

请求示例 更新专属主机属性，在创建云服务器时，不允许云服务器自动分配在一台可用的专属主机上；将专属主机名称更新为DeH_vm3。 PUT https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/dedicated-hosts/74259164-e63a-4ad9-9c77-a1bd2c9aa187{ "dedicated_host": { "auto_placement": "off", "name": "DeH_vm3" }}

请求消息 表2 请求参数 参数 是否必选 参数类型 描述 dedicated_host 是 Object 专属主机，详情请参见表3 dedicated_host字段数据结构说明。 表3 dedicated_host字段数据结构说明 参数 位置 参数类型 是否必选 描述 auto_placement in String 否 在创建云服务器时（未指定专属主机ID），是否允许云服务器自动分配在一台可用的专属主机上。 取值范围：“on”或“off”。 name in String 否 专属主机名称。

API概览 目前还未提供购买、删除专属主机的接口，您只能通过管理控制台创建或删除，其他如查询专属主机详情、列表等操作，可以使用接口。 表1 接口说明 类型/接口 说明 查询专属主机列表 查询专属主机列表，可以在URI中增加flavor、dedicated_host_id、state等参数，来过滤查询结果。 查询专属主机详情 查询某一台专属主机的详细信息，例如：专属主机的名称、所属的可用区、可用的vCPU核数、可用的内存大小等。 查询专属主机上的云服务器 查询专属主机上已部署的云服务器信息，例如：云服务器的名称、ID、状态等。 更新专属主机属性 使用该接口可以修改专属主机名称，以及是否开启自动部署功能。开启自动部署后，云服务器可自动调度到这台专属主机上。 查询可用的专属主机类型 查询某一AZ内可用的专属主机类型。 查询API版本信息 查询专属主机当前所有可用的版本信息列表以及指定的版本信息。 专属主机标签管理 为专属主机增删标签，以及按标签搜索专属主机。 配额设置 查询租户的专属主机配额。 在专属主机上创建云服务器的相关接口，请参考《弹性云服务器API参考》。

响应消息 响应参数 表2 响应参数 参数 参数类型 描述 tags Array of objects 标签列表。 详情请参见表3。 表3 tag字段数据结构说明 名称 参数类型 说明 key String 标签键。 value String 标签值。 响应样例 { "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value2" } ]}

响应消息 响应参数 表3 响应参数 参数 参数类型 描述 quota_set Array of objects 专属主机的配额。 详情请参见表4。 表4 quota_set字段数据结构说明 参数 参数类型 描述 resource String 配额类别。 hard_limit Integer 配额最大限制。 “-1”表示资源配额不受限制。 used Integer 已使用配额数量。 响应样例 { "quota_set": [ { "resource": "c1", "hard_limit": 5, "used": 2 }, { "resource": "m1", "hard_limit": 5, "used": 0 }, { "resource": "h1", "hard_limit": 5, "used": 2 }, { "resource": "d1", "hard_limit": 5, "used": 2 } ]}

请求消息 请求参数 可以在URI中添加“resource”参数，例如： /v1.0/{project_id}/quota-sets/{tenant_id}?resource={resource} 表2 请求参数 参数 位置 参数类型 是否必选 描述 resource query String 否 配额类别。 请求样例 GET https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/quota-sets/45df5566cb3443ab910cf0daebcapoi8

调用API获取项目ID 项目ID可以通过调用查询指定条件下的项目列表API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects”，其中{Endpoint}为IAM的终端节点，可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。 响应示例如下，其中projects下的“id”即为项目ID。 { "projects": [ { "domain_id": "65382450e8f64ac0870cd180d14e684b", "is_domain": false, "parent_id": "65382450e8f64ac0870cd180d14e684b", "name": "project_name", "description": "", "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99" }, "id": "a4a5d4098fb4474fa22cd05f897d6b99", "enabled": true } ], "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects" }}

概述 欢迎使用专属主机（Dedicated Host，DeH）。专属主机是指用户可独享的专属物理主机资源。您可以将云服务器创建在您的专属主机上，满足您对隔离性、安全性、性能的更高要求。同时，您还可以在迁移业务至专属主机时，继续使用迁移前的服务器端软件许可，即支持自带许可（BYOL），提高对云服务器的自治。 您可以使用本文档提供API对专属主机进行相关操作，如查询、删除、更新等。支持的全部操作请参见API概览。 在调用专属主机API之前，请确保已经充分了解专属主机相关概念，详细信息请参见“专属主机产品介绍”。 父主题： 使用前必读

状态码 正常 返回值 说明 200 OK 服务器已成功处理了请求。 201 Created 请求成功并且服务器创建了新的资源。 202 Accepted 服务器已接受请求，延迟处理。 204 No Content 服务器成功处理了请求，但没有返回任何内容。 异常 返回值 说明 400 Bad Request 服务器未能处理请求。 401 Unauthorized 被请求的页面需要用户名和密码。 403 Forbidden 对被请求页面的访问被禁止。 404 Not Found 服务器无法找到被请求的页面。 405 Method Not Allowed 请求中指定的方法不被允许。 406 Not Acceptable 服务器生成的响应无法被客户端所接受。 407 Proxy Authentication Required 用户必须首先使用代理服务器进行验证，这样请求才会被处理。 408 Request Timeout 请求超出了服务器的等待时间。 409 Conflict 由于冲突，请求无法被完成。 500 Internal Server Error 请求未完成。服务异常。 501 Not Implemented 请求未完成。服务器不支持所请求的功能。 502 Bad Gateway 请求未完成。服务器从上游服务器收到一个无效的响应。 503 Service Unavailable 请求未完成。系统暂时异常。 504 Gateway Timeout 网关超时。 父主题： 公共参数

响应消息 响应参数 表2 响应参数 参数 位置 参数类型 描述 dedicated_host_types body Array of objects 可用的专属主机类型。详情参见表3。 表3 dedicated_host_types字段数据结构说明 参数 参数类型 描述 host_type String 专属主机类型。 host_type_name String 专属主机类型名字。 响应样例 { "dedicated_host_types": [ { "host_type": "General", "host_type_name": "General Computing" }, { "host_type": "m1", "host_type_name": "Memory-optimized" }, { "host_type": "h2", "host_type_name": "High performance" }, { "host_type": "d1", "host_type_name": "Disk intensive" } ]}

多边形 多边形由一系列点代表（多边形的顶点）。多边形可以认为与闭合路径一样，但是存储方式不一样而且有自己的一套支持函数。 用下面的语法描述polygon的数值： ( ( x1 , y1 ) , ... , ( xn , yn ) )( x1 , y1 ) , ... , ( xn , yn )( x1 , y1 , ... , xn , yn )x1 , y1 , ... , xn , yn 点表示多边形的端点。 多边形输出使用第一种语法。

路径 路径由一系列连接的点组成。路径可能是开放的，也就是认为列表中第一个点和最后一个点没有连接，也可能是闭合的，这时认为第一个和最后一个点连接起来。 用下面的语法描述path的数值： [ ( x1 , y1 ) , ... , ( xn , yn ) ]( ( x1 , y1 ) , ... , ( xn , yn ) )( x1 , y1 ) , ... , ( xn , yn )( x1 , y1 , ... , xn , yn )x1 , y1 , ... , xn , yn 点表示组成路径的线段的端点。方括弧（[]）表明一个开放的路径，圆括弧（()）表明一个闭合的路径。当最外层的括号被省略，如在第三至第五语法，会假定一个封闭的路径。 路径的输出使用第一种或第二种语法输出。

inet inet类型在一个数据区域内保存主机的IPv4或IPv6地址，以及一个可选子网。主机地址中网络地址的位数表示子网（“子网掩码”）。如果子网掩码是32并且地址是IPv4，则这个值不表示任何子网，只表示一台主机。在IPv6里，地址长度是128位，因此128位表示唯一的主机地址。 该类型的输入格式是address/y，address表示IPv4或者IPv6地址，y是子网掩码的二进制位数。如果省略/y，则子网掩码对IPv4是32，对IPv6是128，所以该值表示只有一台主机。如果该值表示只有一台主机，/y将不会显示。 inet和cidr类型之间的基本区别是inet接受子网掩码，而cidr不接受。

cidr cidr（无类别域间路由，Classless Inter-Domain Routing）类型，保存一个IPv4或IPv6网络地址。声明网络格式为address/y，address表示IPv4或者IPv6地址，y表示子网掩码的二进制位数。如果省略y，则掩码部分使用已有类别的网络编号系统进行计算，但要求输入的数据已经包括了确定掩码所需的所有字节。 示例一：CIDR格式换算为IP地址网段 例如10.0.0.0/8，换算为32位二进制地址：00001010.00000000.00000000.00000000。其中/8表示8位网络ID，即32位二进制地址中前8位是固定不变的，对应网段为：00001010.00000000.00000000.00000000~00001010.11111111.11111111.11111111。则换算为十进制后，10.0.0.0/8表示：子网掩码为255.0.0.0，对应网段为10.0.0.0~10.255.255.255。 示例二：IP地址网段换算为CIDR格式 例如192.168.0.0~192.168.31.255，后两段IP换算为二进制地址：00000000.00000000~00011111.11111111，可以得出前19位（8*2+3）是固定不变的，则换算为CIDR格式后，表示为：192.168.0.0/19。 表2 cidr类型输入举例 cidr输入 cidr输出 abbrev（cidr） 192.168.100.128/25 192.168.100.128/25 192.168.100.128/25 192.168/24 192.168.0.0/24 192.168.0/24 192.168/25 192.168.0.0/25 192.168.0.0/25 192.168.1 192.168.1.0/24 192.168.1/24 192.168 192.168.0.0/24 192.168.0/24 10.1.2 10.1.2.0/24 10.1.2/24 10.1 10.1.0.0/16 10.1/16 10 10.0.0.0/8 10/8 10.1.2.3/32 10.1.2.3/32 10.1.2.3/32 2001:4f8:3:ba::/64 2001:4f8:3:ba::/64 2001:4f8:3:ba::/64 2001:4f8:3:ba:2e0:81ff:fe22:d1f1/128 2001:4f8:3:ba:2e0:81ff:fe22:d1f1/128 2001:4f8:3:ba:2e0:81ff:fe22:d1f1

macaddr macaddr类型存储MAC地址，也就是以太网卡硬件地址（尽管MAC地址还用于其它用途）。可以接受下列格式： '08:00:2b:01:02:03''08-00-2b-01-02-03''08002b:010203''08002b-010203''0800.2b01.0203''08002b010203' 这些示例都表示同一个地址。对于数据位a到f，大小写都行。输出时都是以第一种形式展示。

pg_advisory_lock(key bigint) 描述：获取会话级别的排它咨询锁。 返回值类型：void 备注：pg_advisory_lock锁定应用程序定义的资源，该资源可以用一个64位或两个不重叠的32位键值标识。如果已经有另外的会话锁定了该资源，则该函数将阻塞到该资源可用为止。这个锁是排它的。多个锁定请求将会被压入栈中，因此，如果同一个资源被锁定了三次，它必须被解锁三次以将资源释放给其他会话使用。