华为云用户手册

  • 响应参数 状态码: 200 表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参数 参数 是否必选 参数类型 描述 transaction_split 是 String 开启/关闭事务拆分,取值范围是[ON/OFF] proxy_id_list 是 Array of strings 实例的proxy列表
  • Token认证 Token的有效期为24小时,需要使用一个Token鉴权时,可以先缓存起来,避免频繁调用。 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 Token可通过调用获取用户Token接口获取,调用本服务API需要project级别的Token,即调用获取用户Token接口时,请求body中auth.scope的取值需要选择project,如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } } } 在构造请求中以调用获取用户Token接口为例说明了如何调用API。 获取Token后,再调用其他接口时,您需要在请求消息头中添加“X-Auth-Token”,其值即为Token。例如Token值为“ABCDEFJ....”,则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可,如下所示。 123 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/projectsContent-Type: application/jsonX-Auth-Token: ABCDEFJ....
  • AK/SK认证 AK/SK签名认证方式仅支持消息体大小12MB以内,12MB以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名,在请求时将签名信息添加到消息头,从而通过身份认证。 AK(Access Key ID):访问密钥ID。与私有访问密钥关联的唯一标识符;访问密钥ID和私有访问密钥一起使用,对请求进行加密签名。 SK(Secret Access Key):与访问密钥ID结合使用的密钥,对请求进行加密签名,可标识发送方,并防止请求被修改。 使用AK/SK认证时,您可以基于签名算法使用AK/SK对请求进行签名,也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能,与服务提供的SDK不同,使用时请注意。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 X-Language 否 String 语言。 表3 请求Body参数 参数 是否必选 参数类型 描述 delay 否 Boolean 实例是否延迟升级,默认false,立即升级。 true: 延迟升级,实例将在运维时间窗内自动升级。 false: 立即升级。 缺省值:false
  • 响应示例 状态码: 202 Success. { "flavors" : [ { "vcpus" : "1", "ram" : "4", "type" : "x86", "id" : "3169caaf-6c2f-41d5-aadd-c8fc3d83597e", "spec_code" : "gaussdb.mysql.xlarge.x86.4", "instance_mode" : "Cluster", "version_name" : "8.0", "az_status" : { "az1" : "normal", "az2" : "normal" } } ]}
  • URI GET /mysql/v3/{project_id}/flavors/{database_name} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 database_name 是 String 数据库引擎名称。 表2 Query参数 参数 是否必选 参数类型 描述 version_name 否 String 数据库版本号,目前仅支持兼容MySQL 8.0。 availability_zone_mode 是 String 规格的可用区模式,现在仅支持"single"、"multi",不区分大小写。 spec_code 否 String 规格编码。
  • 响应参数 状态码: 201 表4 响应Body参数 参数 参数类型 描述 size Integer 扩容后容量。 order_id String 订单号。 状态码: 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参数 参数 是否必选 参数类型 描述 size 是 Integer 扩容后的容量。包周期实例初始最小磁盘规格为10G,实例所选容量大小必须为10的整数倍,且大于实际使用容量,最大为128000GB. 取值范围: 扩容时必须大于等于20G; 缩容时必须大于等于10G。 is_auto_pay 否 String 表示是否自动从客户的账户中支付。 true,为自动支付,默认该方式。 false,为手动支付。
  • 响应示例 状态码: 200 Success. { "job" : { "id" : "31b8ae23-c687-4d80-b7b4-42a66c9bb886", "name" : "CreateGaussDBforMySQLInstance", "status" : "Completed", "created" : "2018-08-06T10:41:14+0800", "ended" : "2018-08-06T16:41:14+0000", "process" : "", "instance" : { "id" : "a48e43ff268f4c0e879652d65e63d0fbin07", "name" : "DO-NOT-TOUCH-mgr2-mysql-single" }, "entities" : { "instance" : { "endpoint" : "192.168.1.203:3306", "type" : "Cluster", "datastore" : { "type" : "gaussdb-mysql", "version" : "8.0" } }, "resource_ids" : [ "a48e43ff268f4c0e879652d65e63d0fbin07.vm", "a48e43ff268f4c0e879652d65e63d0fbin07.volume" ] } }}
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 job GetJobInfoDetail object 任务信息。 表5 GetJobInfoDetail 参数 参数类型 描述 id String 任务ID。 name String 任务名称。 status String 任务执行状态。 取值: 值为“Pending”,表示延时任务,未执行。 值为“Running”,表示任务正在执行。 值为“Completed”,表示任务执行成功。 值为“Failed”,表示任务执行失败。 枚举值: Pending Running Completed Failed created String 创建时间,格式为"yyyy-mm-ddThh:mm:ssZ"。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 说明:创建时返回值为空,数据库实例创建成功后该值不为空。 ended String 结束时间,格式为"yyyy-mm-ddThh:mm:ssZ"。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 说明:创建时返回值为空,数据库实例创建成功后该值不为空。 process String 任务执行进度。执行中状态才返回执行进度,例如60%,否则返回""。 instance GetJobInstanceInfoDetail object 指定ID任务的实例信息。 entities Object 根据不同的任务,显示不同的内容。 fail_reason String 任务执行失败时的错误信息。 表6 GetJobInstanceInfoDetail 参数 参数类型 描述 id String 实例ID。 name String 实例名称。 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码: 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。
  • 响应消息体(可选) 该部分可选。响应消息体通常以结构化格式(如JSON或XML)返回,与响应消息头中Content-Type对应,传递除响应消息头之外的内容。 对于获取用户Token接口,返回如下消息体。为篇幅起见,这里只展示部分内容。 { "token": { "expires_at": "2019-02-13T06:52:13.855000Z", "methods": [ "password" ], "catalog": [ { "endpoints": [ { "region_id": "az-01",...... 当接口调用出错时,会返回错误码及错误信息说明,错误响应的Body体格式如下所示。 {"error_code": "AS.0001","error_msg": "The format of message is error"} 其中,“error_code”表示错误码,“error_msg”表示错误描述信息。
  • API概览 通过使用GaussDB(for MySQL)接口,您可以使用GaussDB(for MySQL)查询资源配额、设置资源配额、修改资源配额的功能。 类型 说明 查询数据库引擎的版本 获取指定数据库引擎对应的数据库版本信息。 查询数据库规格 获取指定数据库引擎版本对应的规格信息。 实例管理 包含创建实例、查询实例列表、查询实例详细信息、删除实例、新增只读节点、删除只读节点、扩容包周期实例磁盘容量、修改实例名称、重置数据库密码、变更数据库实例的规格接口。 备份管理 包含创建手动备份、查询备份列表、查询自动备份策略、修改自动备份策略接口。 参数模板管理 包含查询参数模板接口。 配额管理 包含查询资源配额、设置资源配额、修改资源配额接口。 数据库代理 包含查询数据库代理信息、查询数据库代理规格信息、开启数据库代理和关闭数据库代理接口。 日志管理 包含查询数据库错误日志和查询数据库慢日志接口。 标签管理 包含批量添加标签、批量删除标签、查询项目标签等接口。 数据库用户管理 包括创建数据库用户、查询数据库用户、删除数据库用户、授权数据库用户和删除数据库权限等接口。 数据库管理 包括创建数据库、查询数据库列表、删除数据库、修改数据库备注等接口。 SQL限流 包含查询SQL限流规则、设置SQL限流规则、删除SQL限流规则等接口。 获取任务信息 获取任务中心的任务信息。
  • 基本概念 帐号 用户注册时的帐号,帐号对其所拥有的资源及云服务具有完全的访问权限,可以重置用户密码、分配用户权限等。由于帐号是付费主体,为了确保帐号安全,建议您不要直接使用帐号进行日常管理工作,而是创建用户并使用他们进行日常管理工作。 用户 由帐号在IAM中创建的用户,是云服务的使用人员,具有身份凭证(密码和访问密钥)。 在我的凭证下,您可以查看帐号ID和用户ID。通常在调用API的鉴权过程中,您需要用到帐号、用户和密码等信息。 区域 指云资源所在的物理位置,同一区域内可用区间内网互通,不同区域间内网不互通。通过在不同地区创建云资源,可以将应用程序设计的更接近特定客户的要求,或满足不同地区的法律或其他要求。 可用区 一个可用区是一个或多个物理数据中心的集合,有独立的风火水电,AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连,以满足用户跨AZ构建高可用性系统的需求。 项目 区域默认对应一个项目,这个项目由系统预置,用来隔离物理区域间的资源(计算资源、存储资源和网络资源),以默认项目为单位进行授权,用户可以访问您帐号中该区域的所有资源。如果您希望进行更加精细的权限控制,可以在区域默认的项目中创建子项目,并在子项目中购买资源,然后以子项目为单位进行授权,使得用户仅能访问特定子项目中资源,使得资源的权限控制更加精确。 图1 项目隔离模型 同样在我的凭证下,您可以查看项目ID。 企业项目 企业项目是项目的升级版,针对企业不同项目间资源的分组和管理,是逻辑隔离。企业项目中可以包含多个区域的资源,且项目中的资源可以迁入迁出。 关于企业项目ID的获取及企业项目特性的详细信息,请参见《企业管理服务用户指南》。 父主题: 使用前必读
  • 支持的授权项 策略包含系统策略和自定义策略,如果系统策略不满足授权要求,管理员可以创建自定义策略,并通过给用户组授予自定义策略来进行精细的访问控制。策略支持的操作与API相对应,授权项列表说明如下: 权限:允许或拒绝某项操作。 对应API接口:自定义策略实际调用的API接口。 授权项:自定义策略中支持的Action,在自定义策略中的Action中写入授权项,可以实现授权项对应的权限功能。 依赖的授权项:部分Action存在对其他Action的依赖,需要将依赖的Action同时写入授权项,才能实现对应的权限功能。 IAM项目(Project)/企业项目(Enterprise Project):自定义策略的授权范围,包括IAM项目与企业项目。授权范围如果同时支持IAM项目和企业项目,表示此授权项对应的自定义策略,可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目,不支持企业项目,表示仅能在IAM中给用户组授权并生效,如果在企业管理中授权,则该自定义策略不生效。关于IAM项目与企业项目的区别,详情请参见:IAM与企业管理的区别。 “√”表示支持,“x”表示暂不支持。
  • 请求消息体(可选) 该部分可选。请求消息体通常以结构化格式(如JSON或XML)发出,与请求消息头中Content-Type对应,传递除请求消息头之外的内容。若请求消息体中的参数支持中文,则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于获取用户Token接口,您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示,加粗的斜体字段需要根据实际值填写,其中username为用户名,domainname为用户所属的帐号名称,********为用户登录密码,xxxxxxxxxxxxxxxxxx为project的名称,如“cn-north-1”,您可以从地区和终端节点获取。 scope参数定义了Token的作用域,上面示例中获取的Token仅能访问project下的资源。您还可以设置Token的作用域为某个帐号下所有资源或帐号的某个project下的资源,详细定义请参见获取用户Token。 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokensContent-Type: application/json{ "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxxxxxxxxxxxx" } } }} 到这里为止这个请求需要的内容就具备齐全了,您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口,返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后,您就可以使用Token认证调用其他API。
  • 请求消息头 附加请求头字段,如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”,请求鉴权信息等。 详细的公共请求消息头字段请参见表3。 表3 公共请求消息头 名称 描述 是否必选 示例 Host 请求的服务器信息,从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口,https的默认端口为443。 否 使用AK/SK认证时该字段必选。 code.test.com or code.test.com:443 Content-Type 发送的实体的MIME类型。推荐用户默认使用application/json,如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。 是 application/json Content-Length 请求body长度,单位为Byte。 否 3495 X-Project-Id project id,项目编号。请参考获取项目ID章节获取项目编号。 否 e9993fc787d94b6c886cbaa340f9c0f4 X-Auth-Token 用户Token。 用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 否 使用Token认证时该字段必选。 注:以下仅为Token示例片段 MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ 对于获取用户Token接口,由于不需要认证,所以只添加“Content-Type”即可,添加消息头后的请求如下所示。 12 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokensContent-Type: application/json
  • 请求方法 HTTP请求方法(也称为操作或动词),它告诉服务你正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 在获取用户Token的URI部分,您可以看到其请求方法为“POST”,则其请求为: 1 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens
  • 请求URI 请求URI由如下部分组成: {URI-scheme}://{Endpoint}/{resource-path}?{query-string} 尽管请求URI包含在请求消息头中,但大多数语言或框架都要求您从请求消息中单独传递它,所以在此单独强调。 表1 URI中的参数说明 参数 描述 URI-scheme 表示用于传输请求的协议,当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器域名或IP,不同服务不同区域的Endpoint不同,您可以从地区和终端节点获取。 例如IAM服务在“华北-北京一”区域的Endpoint为“iam.cn-north-1.myhuaweicloud.com”。 resource-path 资源路径,即API访问路径。从具体API的URI模块获取,例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string 查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“limit=10”,表示查询不超过10条数据。 例如您需要获取IAM在“华北-北京一”区域的Token,则需使用“华北-北京一”区域的Endpoint(iam.cn-north-1.myhuaweicloud.com),并在获取用户Token的URI部分找到resource-path(/v3/auth/tokens),拼接起来如下所示。 1 https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为查看方便,在每个具体API的URI部分,只给出resource-path部分,并将请求方法写在一起。这是因为URI-scheme都是HTTPS,而Endpoint在同一个区域也相同,所以简洁起见将这两部分省略。
  • GaussDB(for MySQL)授权分类 表1 授权列表 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 查询资源配额 GET /mysql/v3/{project_id}/quotas gaussdb:instance:list √ √ 设置资源配额 POST /mysql/v3/{project_id}/quotas gaussdb:quota:modify √ √ 修改资源配额 PUT /mysql/v3/{project_id}/quotas gaussdb:quota:modify √ √ 查询数据库引擎版本 GET /mysql/v3/{project_id}/datastores/{database_name} gaussdb:instance:list √ √ 查询数据库规格 GET /mysql/v3/{project_id}/flavors/{database}?version_name={version_name}&spec_code={spec_code} gaussdb:instance:list √ √ 创建实例 POST /mysql/v3/{projectId}/instances gaussdb:instance:create √ √ 查询实例列表 GET /mysql/v3/{projectId}/instances gaussdb:instance:list √ √ 查询实例详细信息 GET /mysql/v3/{project_id}/instances/{instance_id} gaussdb:instance:list √ √ 删除实例 DELETE /mysql/v3/{project_id}/instances/{instance_id} gaussdb:instance:delete √ √ 查询参数模板 GET /mysql/v3/{project_id}/configurations gaussdb:param:list √ √ 获取任务信息 GET /mysql/v3/{projectId}/jobs gaussdb:instance:list √ √ 新增只读节点 POST /mysql/v3/{project_id}/instances/{instance_id}/nodes/enlarge gaussdb:instance:create √ √ 删除只读节点 DELETE /mysql/v3/{project_id}/instances/{instance_id}/nodes/{node_id} gaussdb:instance:delete √ √ 扩容包周期实例磁盘容量 POST /mysql/v3/{project_id}/instances/{instance_id}/volume/extend gaussdb:instance:modifySpec √ √ 修改实例名称 PUT /mysql/v3/{project_id}/instances/{instance_id}/name gaussdb:instance:modify √ √ 重置数据库密码 POST /mysql/v3/{project_id}/instances/{instance_id}/password gaussdb:instance:modify √ √ 变更数据库实例的规格 POST /mysql/v3/{project_id}/instances/{instance_id}/action gaussdb:instance:modifySpec √ √ 创建手动备份 POST /mysql/v3/{project_id}/backups/create gaussdb:backup:create √ √ 查询备份列表 GET /mysql/v3/{project_id}/backups gaussdb:backup:list √ √ 查询自动备份策略 GET /mysql/v3/{project_id}/instances/{instance_id}/backups/policy gaussdb:backup:list √ √ 修改自动备份策略 PUT /mysql/v3/{project_id}/instances/{instance_id}/backups/policy/update gaussdb:instance:modifyBackupPolicy √ √ 父主题: 权限策略和授权项
  • 调用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" }}
  • 响应示例 状态码: 200 Success. { "total_count" : 1, "instances" : [ { "id" : "d738399de028480fabb2b8120d4e01a4in07", "name" : "gaussdb-mysql-instance01", "status" : "ACTIVE", "port" : 3306, "type" : "Cluster", "private_ips" : [ "192.168.0.142" ], "readonly_private_ips" : [ "192.168.0.228", "192.168.0.165" ], "proxy_ips" : [ "192.168.0.15" ], "db_user_name" : "root", "region" : "cn-north-4", "datastore" : { "type" : "gaussdb-mysql", "version" : "8.0", "kernel_version" : "2.0.29.1" }, "created" : "2018-08-20T02:33:49_0800", "updated" : "2018-08-20T02:33:49_0800", "volume" : { "type" : "POOL", "size" : 100 }, "vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58", "subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad", "security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55", "flavor_ref" : "gaussdb.mysql.c3.small.4", "flavor_info" : { "vcpus" : 8, "ram" : 16 }, "backup_strategy" : { "start_time" : "19:00-20:00", "keep_days" : 7 }, "charge_info" : { "charge_mode" : "postPaid" }, "enterprise_project_id" : 0, "time_zone" : "UTC", "tags" : [ ] } ]}
  • 请求示例 查询GaussDB(for MySQL)实例列表,读写内网IP是192.168.0.142。 GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances?id=61a4ea66210545909d74a05c27a7179ein07&name=hyAbc&type=Cluster&datastore_type=gaussdb-mysql&vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7&private_ip=192.168.0.142&offset=0&limit=10&tags=taurusKey1=value1
  • URI GET /v3/{project_id}/instances 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 id 否 String 实例ID。“*”为系统保留字符,如果id是以“*”起始,表示按照“*”后面的值模糊匹配,否则,按照id精确匹配查询。不能只传入“*”。 name 否 String 实例名称。 “*”为系统保留字符,如果name是以“*”起始,表示按照“*”后面的值模糊匹配,否则,按照name精确匹配查询。不能只传入“*”。 type 否 String 按照实例类型查询。目前仅支持Cluster。 datastore_type 否 String 数据库类型,现在只支持gaussdb-mysql。 vpc_id 否 String 虚拟私有云ID。 subnet_id 否 String 子网的网络ID信息。 private_ip 否 String 读写内网IP。 readonly_private_ip 否 String 读内网IP。 proxy_ip 否 String 读写分离IP。 offset 否 Integer 索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。 limit 否 Integer 查询记录数。默认为100,不能为负数,最小值为1,最大值为100。 tags 否 String 根据实例标签键值对进行查询。 {key}表示标签键。 {value}表示标签值。 如果同时使用多个标签键值对进行查询,中间使用逗号分隔开,表示查询同时包含指定标签键值对的实例。key不能重复,key之间是与的关系。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 instances Array of MysqlInstanceListInfo objects 实例列表信息。 total_count Integer 总记录数。 表5 MysqlInstanceListInfo 参数 参数类型 描述 id String 实例ID。 name String 创建的实例名称。 status String 实例状态。 private_ips Array of strings 实例写内网IP地址列表。弹性云服务器创建成功后该值存在,其他情况下为空字列表。 proxy_ips Array of strings 实例读写分离IP地址列表。GaussDB(for MySQL)实例开启代理成功后该值存在,其他情况下为空列表。 readonly_private_ips Array of strings 实例读内网IP地址列表。弹性云服务器创建成功后该值存在,其他情况下为空列表。 public_ips Array of strings 实例外网IP地址列表。 port String 数据库端口号。 type String 实例类型,取值为“Cluster”。 region String 实例所在区域。 datastore MysqlDatastoreWithKernelVersion object 数据库信息。 created String 创建时间,格式为"yyyy-mm-ddThh:mm:ssZ"。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 说明:创建时返回值为空,数据库实例创建成功后该值不为空。 updated String 更新时间,格式与"created"字段对应格式完全相同。 说明:创建时返回值为空,数据库实例创建成功后该值不为空。 db_user_name String 默认用户名。 vpc_id String 虚拟私有云ID。 subnet_id String 子网的网络ID信息。 security_group_id String 安全组ID。 flavor_ref String 规格码。 flavor_info MysqlFlavorInfo object flavor规格信息。 volume MysqlVolumeInfo object 存储盘信息。 backup_strategy MysqlBackupStrategy object 自动备份策略 enterprise_project_id String 企业项目ID。 time_zone String 时区。 charge_info MysqlChargeInfo object 计费类型信息,支持包年包月和按需,默认为按需。 dedicated_resource_id String 专属资源池ID,只有数据库实例属于专属资源池才会返回该参数。 tags Array of InstanceTagItem objects 标签列表。 表6 MysqlDatastoreWithKernelVersion 参数 参数类型 描述 type String 数据库引擎,现在只支持gaussdb-mysql version String 数据库版本。 数据库支持的详细版本信息,可调用查询数据库引擎的版本接口获取。 kernel_version String 数据库内核版本 表7 MysqlFlavorInfo 参数 参数类型 描述 vcpus String CPU核数。 ram String 内存大小,单位GB。 表8 MysqlVolumeInfo 参数 参数类型 描述 type String 磁盘类型。 size String 已使用磁盘大小,单位GB。 表9 MysqlBackupStrategy 参数 参数类型 描述 start_time String 自动备份开始时间段。自动备份将在该时间一个小时内触发。 取值范围:非空,格式必须为hh:mm-HH:MM且有效,当前时间指UTC时间。 HH取值必须比hh大1。 mm和MM取值必须相同,且取值必须为00。 keep_days String 自动备份保留天数,取值范围:1-732 表10 MysqlChargeInfo 参数 参数类型 描述 charge_mode String 计费模式。 取值范围: prePaid:预付费,即包年/包月。 postPaid:后付费,即按需付费。 枚举值: prePaid postPaid period_type String 订购周期类型。 取值范围: month:包月。 year:包年。 说明:“charge_mode”为“prePaid”时生效,且为必选值。 枚举值: month year period_num Integer “charge_mode”为“prePaid”时生效,且为必选值,指定订购的时间。 取值范围: 当“period_type”为“month”时,取值为1~9。 当“period_type”为“year”时,取值为1~3。 is_auto_renew String 创建包周期实例时可指定,表示是否自动续订,续订的周期和原周期相同,且续订时会自动支付。 true,为自动续订。 false,为不自动续订,默认该方式。 is_auto_pay String 创建包周期时可指定,表示是否自动从客户的账户中支付,此字段不影响自动续订的支付方式。 true,为自动支付,默认该方式。 false,为手动支付。 表11 InstanceTagItem 参数 参数类型 描述 key String 标签键。 value String 标签值。 状态码: 400 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码: 500 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。
  • 错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 DBS.200001 Parameter error. 参数错误。 检查传入的参数或URL是否全部正确。 400 DBS.200004 Parameter error. 参数错误。 检查传入的参数或URL是否全部正确。 400 DBS.200006 The request is null. Enter a request parameter. 请求为空,请输入请求参数。 检查是否有必选请求参数为空。 400 DBS.200021 Invalid DB instance name. 实例名非法。 检查实例名称是否正确。 400 DBS.200023 Storage space is out of range. 卷大小超出允许范围。 检查磁盘大小是否超出允许范围。 400 DBS.200024 Invalid region. Region非法。 检查可用区名称是否正确,可用区是否在可用范围内。 400 DBS.200025 Invalid AZ. 可用区取值非法。 检查可用区名称是否正确,可用区是否在可用范围内。 400 DBS.200026 Invalid storage type. 卷类型非法。 检查磁盘类型是否正确。 400 DBS.200027 Storage space must be a multiple of 10. 卷大小不是10的整数倍。 检查磁盘大小是否是10的整数倍。 400 DBS.200040 The DB engine or version is not supported. 不支持的数据库类型或版本。 检查是否数据库类型和版本是否匹配,数据库类型和版本是否符合要求。 400 DBS.200041 Invalid database version. 数据库版本非法。 检查数据库的版本号是否支持。 400 DBS.200042 The DB engine does not exist. 引擎版本不存在。 检查数据库引擎是否为云数据库 GaussDB支持的引擎。 400 DBS.200043 Invalid synchronize model. HA同步模式非法。 检查HA同步模式是否符合要求。 400 DBS.200048 Invalid VPC ID. VPC id非法。 检查VPC ID、名称是否正确,是否符合要求。 400 DBS.200049 Invalid subnet ID. 子网的网络id非法。 检查子网ID、名称是否正确,是否符合要求。 400 DBS.200051 Invalid HA mode. 不合法的ha模式。 检查HA模式是否符合要求。 400 DBS.200052 Invalid database root password. 数据库root密码非法。 检查用户名和密码是否匹配,密码是否符合密码要求。 400 DBS.200053 The selected specifications do not exist. 所选规格不存在。 检查规格是否正确,当前可用区是否支持该规格。 400 DBS.200054 Invalid specifications. 所选规格非法。 检查规格是否正确,当前可用区是否支持该规格。 400 DBS.200056 The maximum number of nodes has been reached. 节点个数达到最大值。 检查实例节点个数是否达到最大值。 400 DBS.200063 Invalid cluster mode. 集群模式非法。 检查传入的mode参数是否非法。 400 DBS.200086 This operation is not allowed by the DB instance status. 实例状态不允许做该操作。 检查实例的状态或实例正在进行的操作是否与请求冲突。 400 DBS.200087 The number of tags added for the DB instance has reached the quota. 单个实例标签数量达到最大配额。 检查实例的标签是否超过最大限制 400 DBS.200098 The tag already exists. 该资源标签已存在。 检查标签是否已经存在。 400 DBS.200302 Storage space must be a multiple of 10. 磁盘大小不是10的整数倍。 检查磁盘大小是否是10的倍数。 400 DBS.200306 The new storage space must be greater than or equal to the original storage space. 扩容参数不合法。 检查设置的磁盘大小是否已经超过上限。 400 DBS.200461 The parameter value is out of range. 参数值超出范围。 检查传入的port参数是否非法 400 DBS.200504 Invalid database version. 数据库版本非法。 检查传入的数据库版本号是否非法 400 DBS.200543 The job does not exist. 任务不存在 检查传入的任务Id是否非法 400 DBS.200823 The database does not exist. 数据库不存在。 检查传入的数据库是否不存在 400 DBS.200824 The database account does not exist. 数据库帐号不存在。 检查传入的用户是否存在 400 DBS.201014 This operation is not allowed by the DB instance status. 实例状态不允许做该操作。 检查实例的状态或实例正在进行的操作是否与请求冲突。 400 DBS.201101 Invalid backup cycle. 备份周期非法。 检查备份周期是否符合要求。 400 DBS.201103 Invalid backup start time. 备份开始时间非法。 检查备份开始时间是否符合要求。 400 DBS.201106 Invalid retention days. 备份保留天数非法。 检查备份保留天数是否符合要求。 400 DBS.201203 The backup file does not exist. 备份文件不存在。 检查该备份是否存在,备份是否匹配实例。 400 DBS.201207 The DB engine or version is not supported. 不支持该数据库引擎或版本。 检查数据库引擎是否为云数据库 GaussDB支持的引擎。 400 DBS.201208 The operation is not allowed by the backup status. 备份状态不允许。 请检查备份状态是否为"备份完成"。 400 DBS.212002 Incorrect parameter group quota. 参数组配额错误。 参数组配额超过限制,请删除无用的参数模板再重新创建。 400 DBS.212003 Operation not allowed. 不支持此操作。 默认参数模板不允许重置和删除。 400 DBS.212004 Parameter group update error. 参数组更新错误。 请检查要修改的参数值是否合法。 400 DBS.212005 The node does not belong to the group. 节点不属于组。 该节点不属于该实例,请检查实例id或节点Id是否正确。 400 DBS.212007 The DB engine does not exist. 引擎不存在。 检查数据库引擎是否存在。 400 DBS.212008 The DB engine is not supported. 不支持的引擎。 检查数据库引擎是否为云数据库 GaussDB支持的引擎。 400 DBS.212009 Task processing failed. 任务处理失败。 任务处理失败,请联系客服解决。 400 DBS.212010 The parameter group is being applied. 绑定正在执行。 正在应用参数模板,待完成后再进行其他操作。 400 DBS.212011 Application failed. 绑定失败。 应用参数模板失败,请联系客服解决。 400 DBS.212012 The parameter does not exist. 参数不存在。 请检查要修改的参数名是否正确。 400 DBS.212014 The node does not have a default parameter group. 节点没有默认参数组。 请检查节点ID或参数组ID是否正确。 400 DBS.212015 Partial success. 部分成功。 请检查要修改的参数名是否正确。 400 DBS.212016 Parameter update failed. 参数更新失败。 修改参数失败,请联系客服解决。 400 DBS.212017 Invalid parameter. 参数错误。 请检查参数名是否合法。 400 DBS.212025 Update failed. 更新失败。 修改参数失败,请联系客服解决 400 DBS.212030 Parameter error 参数错误。 参数模板名已经存在。 400 DBS.212032 The parameter template has been applied. 参数模板已被应用。 参数模板已经被应用,不能删除该模板。 400 DBS.212037 Parameters are incorrectly set. 参数设置不正确。 检查参数是否合法或参数是否在合法范围内。 400 DBS.270024 Proxy instance does not exist. Proxy实例不存在。 检查租户是否拥有该proxy实例,传入的proxy实例id是否正确,代理实例是否存在。 400 DBS.270025 Invalid weight. 权重非法。 检查传入的权重格式和范围是否正确。 400 DBS.270026 Invalid proxy mode. 数据库代理类型非法。 检查传入的数据库代理类型是否正确。 400 DBS.270027 Select a proxy instance. 未指定数据库代理。 检查参数数据库代理id是否为空。 400 DBS.280001 Parameter error. 参数错误。 检查传入的参数或URL是否全部正确,是否符合要求。 400 DBS.280127 Invalid backup description. 备份描述非法。 检查备份描述是否正确,是否符合要求。 400 DBS.280128 The database name does not exist. 数据库名不存在。 检查租户是否拥有该实例,实例名或实例ID是否正确,实例是否存在。 400 DBS.280203 This is a weak password. Please enter a strong password. 这是一个弱密码,请输入一个强度大一些的密码. 检查密码是否过于简单,请更改为较复杂的密码。 400 DBS.280204 Invalid parameter. 输入参数不合法。 检查参数是否合法或参数是否在合法范围内。 400 DBS.280214 The backup does not exist. 备份不存在。 检查备份保留天数是否正确。 400 DBS.280216 Invalid backup start time. 备份开始时间非法。 检查备份开始时间是否符合要求,备份开始时间和备份结束时间的关系是否正确。 400 DBS.280235 Invalid database type. 数据库类型非法 检查数据库引擎名称是否正确。 400 DBS.280237 Datastore not specified. Datastore为空。 检查数据库引擎是否为云数据库 GaussDB支持的引擎。 400 DBS.280238 The DB engine or version is not supported. 不支持的数据库类型或版本。 检查是否数据库类型和版本是否匹配,数据库类型和版本是否符合要求。 400 DBS.280239 Invalid specifications. 所选规格非法。 检查规格码是否正确,规格在当前可用区是否存在,规格是否支持。 400 DBS.280241 Invalid storage type. 卷类型非法。 检查磁盘的类型是否正确,是否符合要求。 400 DBS.280242 Storage space is out of range. 卷大小超出允许范围。 检查磁盘大小的值是否正确。 400 DBS.280246 Invalid database root password 数据库root密码非法。 检查用户名和密码是否匹配,密码是否符合密码要求。 400 DBS.280250 Invalid backup retention days. 备份保留期非法。 检查输入备份数据的保留时间是否合法或是否在合法范围内。 400 DBS.280251 Invalid backup cycle. 备份周期不合法。 检查输入备份周期是否合法或是否在合法范围内。 400 DBS.280253 Invalid backup start time. 备份开始时间非法。 检查备份开始时间是否符合要求,备份开始时间和备份结束时间的关系是否正确。 400 DBS.280260 Invalid available zone mode. 无效的可用区模式。 检查可用区的模式是否有效。 400 DBS.280270 The parameter does not exist. 参数不存在。 请检查要修改的参数名是否正确。 400 DBS.280271 The parameter value is out of range. 参数值超出范围。 检查参数值是否在有效范围内。 400 DBS.280272 The tag key must be unique. 新增tag存在重复的key。 检查新增tag是否已存在。 400 DBS.280277 Invalid backup name. 备份名称非法。 检查备份名称是否正确,是否符合要求。 400 DBS.280285 Invalid AZ. 可用区取值非法。 检查可用区名称是否正确,可用区是否在可用范围内。 400 DBS.280288 Invalid FlavorRef. 规格非法。 检查规格ID是否为null或空串。 400 DBS.280311 Invalid storage space size. 存储空间大小非法。 检查磁盘大小的值是否正确,是否符合要求。 400 DBS.280325 Invalid storage information. 硬盘信息不合法。 检查磁盘大小或磁盘类型是否合法。 400 DBS.280342 Invalid cluster mode. 集群模式非法。 检查实例模式是否正确,是否符合要求,实例模式与实例ID是否匹配。 400 DBS.280364 Invalid database port. 数据库端口号无效。 检查数据库设置的端口是否可用。 400 DBS.280402 Invalid HA mode. Ha模式非法。 检查输入的Ha模式是否符合要求。 400 DBS.280404 Invalid DB instance ID or node ID format. 实例ID非法。 检查实例ID是否符合规则。 400 DBS.280434 Invalid specification code. 所选规格码非法。 检查规格码是否符合规则,规格是否存在,规格是否可用。 400 DBS.280439 Invalid records. Enter a positive integer less than 100. 无效的查询记录数,请输入小于100的正整数。 检查查询记录数是否在有效范围内。 400 DBS.280448 The storage type is sold out. 当前卷类型已售罄。 检查当前卷类型是否存在可用。 400 DBS.280449 Operation not allowed on frozen objects. 不能对冻结的对象执行该操作。 检查实例是否冻结,当前操作是否支持在实例冻结期间进行。 400 DBS.280450 The DB instance specifications are sold out. 当前规格已售罄。 规格已售罄,请更换可用区或联系客服。 400 DBS.280505 CBC error: There are unprocessed orders. CBC错误:存在未处理的订单,不能进行当前操作。 检查当前订单是否已处理完成。 400 DBS.290000 Parameter error. 参数错误。 检查传入的参数或URL是否全部正确,是否符合要求。 400 DBS.290001 Invalid parameter letter case. 参数大小写错误。 检查传入的参数大小写是否正确,是否符合要求。 403 DBS.200010 The DB instance ID or user ID may be null, or the operation is not authorized. 实例ID和用户ID可能为空,或者操作越权。 检查入参是否正确,实例是否存在,检查租户是否操作越权。 403 DBS.200044 Resource not found or permission denied. 访问资源不存在,或者无访问权限。 检查入参是否正确,访问资源是否存在,检查租户是否有访问权限。 403 DBS.200604 The DB instance ID or user ID may be null, or the operation is not authorized. 实例ID和用户ID可能为空,或者操作越权。 检查入参是否正确,实例是否存在,检查租户是否操作越权。 403 DBS.200810 You are not allowed to create databases on read replicas. 不能在只读实例创建数据库。 只读实例不允许创建数据库,请更换读写实例创建数据库。 403 DBS.200819 You are not allowed to delete database users on read replicas. 不能在只读实例执行删除数据库用户。 只读实例不允许删除数据库用户。 403 DBS.201003 Resource not found or permission denied. 访问资源不存在,或者无访问权限。 检查入参是否正确,访问资源是否存在,检查租户是否有访问权限。 403 DBS.280015 Resource not found or permission denied. 访问资源不存在,或者无访问权限。 检查入参是否正确,访问资源是否存在,检查租户是否有访问权限。 403 DBS.280056 Invalid token. Token非法。 检查实例是否属于租户,token是否已经重新获取。 404 DBS.200002 The DB instance does not exist. 实例不存在。 检查实例ID、实例是否正确,实例是否存在。 404 DBS.200008 The ECS information of the DB instance cannot be found. 请检查数据库,确认实例的虚拟机信息,找不到该实例的虚拟机信息。 检查入参是否正确,实例状态是否正常。 404 DBS.200013 The original DB instance does not exist. 源实例不存在。 检查实例ID、实例是否正确,实例是否存在。 404 DBS.200045 The DB instance does not exist. 实例不存在。 检查实例ID、实例是否正确,实例是否存在。 404 DBS.200050 The security group does not exist or does not belong to the VPC. 安全组不存在,或不属于该VPC。 检查输入安全组ID是否合法,安全组是否存在,节点的读内网地址是否属于该安全组。 404 DBS.200408 The DB instance does not exist. 实例不存在或已删除。 检查实例ID、实例是否正确,实例是否存在。 404 DBS.200470 The region or AZ does not exist. Region或可用区不存在。 检查可用区是否正确。 404 DBS.200501 The subnet does not exist or does not belong to the VPC. 子网不存在,或不属于该VPC。 检查子网ID、名称是否存在,是否匹配VPC。 404 DBS.200503 The VPC does not exist or does not belong to the user. VPC不存在,或不属于该用户。 检查租户是否拥有该VPC。 404 DBS.200602 The DB instance does not exist. 该实例不存在。 检查实例ID、实例是否正确,实例是否存在。 404 DBS.201010 The backup information does not exist. 备份信息不存在。 检查该备份是否存在,备份是否匹配实例。 404 DBS.201028 The DB instance does not exist. 实例不存在或已删除。 检查实例ID、实例是否正确,实例是否存在。 404 DBS.212001 The parameter group does not exist. 参数组不存在。 检查参数组是否存在。 404 DBS.290002 The selected specifications do not exist. 所选规格不存在。 检查规格是否正确,当前可用区是否支持该规格。 404 DBS.290005 The DB instance does not exist. 该实例不存在。 检查实例ID、实例是否正确,实例是否存在。 404 DBS.290011 The DB instance does not exist. 实例不存在。 检查实例ID、实例是否正确,实例是否存在。 404 DBS.290013 Resource not found. 未找到资源。 检查入参是否正确,实例是否存在。 409 DBS.200011 Another operation is being performed on the DB instance or the DB instance is faulty. 该实例正在进行其它操作或该实例故障,无法执行该操作,请稍后重试。 检查实例状态或实例正在进行的操作是否和请求冲突。 409 DBS.200019 Another operation is being performed on the DB instance or the DB instance is faulty. 该实例正在进行其他操作或该实例故障,无法执行该操作,请稍后重试。 检查实例状态或实例正在进行的操作是否和请求冲突。 409 DBS.200022 The DB instance name already exists. 实例名称已存在。 检查实例名称是否已经存在。 409 DBS.200047 Another operation is being performed on the DB instance or the DB instance is faulty. 该实例正在进行其它操作或该实例故障,无法执行该操作,请稍后重试。 检查实例状态或实例正在进行的操作是否和请求冲突。 409 DBS.200316 This operation cannot be performed because the DB instance status is Storage full. 当前实例状态为存储空间满,不能进行该操作。 实例存储空间已满,请调整存储空间大小。 409 DBS.200826 The database name already exists. 数据库名称已存在。 检查数据库名称是否合法。 409 DBS.200827 The database user already exists. 账号名称已存在。 检查数据库用户是否合法。 409 DBS.200828 You are not allowed to create a database built-in account. 数据库内置账号,用户不可创建。 检查数据库用户是否合法。 409 DBS.201202 Another operation is being performed on the DB instance or the DB instance is faulty. 该实例正在进行其它操作或该实例故障,无法执行该操作,请稍后重试。 检查实例状态或实例正在进行的操作是否和请求冲突。 409 DBS.201205 Backup is in progress, please wait. 正在备份中,请稍等。 实例正在备份中,等待备份完成后重试操作。 409 DBS.212006 Another operation is being performed on the DB instance or the DB instance is faulty. 该实例正在进行其它操作或该实例故障,无法执行该操作,请稍后重试。 检查实例状态或实例正在进行的操作是否和请求冲突。 409 DBS.280406 Operation not allowed by the DB instance type or status. 实例类型或状态受限,操作不允许。 操作不允许,可能是实例类型错误或实例状态不允许,请检查实例类型和实例状态。 413 DBS.200046 The number of DB instances has reached the quota. 实例数量达到配额。 实例数量配额达到限制,请联系管理员调整配额。 413 DBS.290003 The number of DB instances has reached the quota. 实例数量达到配额。 实例数量配额达到限制,请联系管理员调整配额。 422 DBS.212019 The parameter cannot be processed. 请求中的参数或对象不能被正确识别。 请求参数错误,请检查参数合法性。 500 DBS.108000 Server failure. 服务器错误。 服务内部错误,请联系客服。 500 DBS.108002 Server failure. 服务器错误。 服务内部错误,请联系客服。 500 DBS.108005 Server failure. 服务器错误。 服务内部错误,请联系客服。 500 DBS.200005 Server failure. 服务器错误。 服务内部错误,请联系客服。 500 DBS.200208 Server failure. 服务器错误。 服务内部错误,请联系客服。 500 DBS.200811 Failed to create the database. 创建数据库失败。 检查失败原因,可能是资源不足,请联系客服。 500 DBS.200821 Failed to modify database user permissions. 修改数据库用户权限失败。 可能是操作状态校验拦截,请重试。 500 DBS.213002 Failed to process the request. 请求处理失败。 服务内部错误,请联系客服。 500 DBS.213004 Failed to process the request. 请求处理失败。 服务内部错误,请联系客服。 500 DBS.290006 Failed to process the request. 请求处理失败。 服务内部错误,请联系客服。 500 DBS.290015 Failed to process the request. 请求处理失败。 服务内部错误,请联系客服。 父主题: 附录
  • 请求示例 查询慢日志详细信息。 POST https://{endpoint}/v3.1/056538411200d4cd2f79c003c7606412/instances/096c0fc43e804757b59946b80dc27f8bin07/slow-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. { "slow_log_list" : [ { "node_id" : "cc07c60e94ec4575989840e648fb4f66no07", "count" : 1, "time" : "1.04899 s", "lock_time" : "0.00003 s", "rows_sent" : 0, "rows_examined" : 0, "database" : "gaussdb-mysql", "users" : "root", "query_sample" : "INSERT INTO time_zone_name (Name, Time_zone_id) VALUES (N @time_zone_id);", "type" : "INSERT", "start_time" : "2022-11-25T10:55:16.000", "client_ip" : "192.*.*.1", "line_num" : 1669344916000 } ]}
  • 请求参数 表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 日志单行序列号,第一次查询时不需要此参数,后续分页查询时需要使用,可从上次查询的返回信息中获取。 operate_type 否 String SQL语句类型,取空值,表示查询所有语句类型,也可指定如下日志类型: INSERT UPDATE SELECT DELETE ALTER DROP CREATE database 否 String 所属数据库。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 slow_log_list Array of LtsLogSlowDetail objects 慢日志列表。 表5 LtsLogSlowDetail 参数 参数类型 描述 node_id String 节点ID。 count String 执行次数。 time String 执行时间。 lock_time String 等待锁时间。 rows_sent String 结果行数量。 rows_examined String 扫描的行数量。 database String 所属数据库。 users String 帐号。 query_sample String 执行语法。 type String 语句类型。 start_time String 发生时间,UTC时间。 client_ip String IP地址。 line_num String 日志单行序列号。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。
共100000条