云服务器内容精选
-
请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 x-auth-token 是 String 用户Token。 通过调用 IAM 服务的“获取用户Token”接口来获取。 表3 请求Body参数 参数 是否必选 参数类型 描述 spec_code 是 String 变更至新规格的资源规格编码。 group_id 否 String 实例默认一个组,此时不需要传入该参数。当使用组功能创建多个组时, 需要传入需要规格变更的对应组的group_id。 is_auto_pay 否 Boolean 变更包年包月实例规格时可指定,表示是否自动从账户中支付,此字段不影响自动续订的支付方式。true,表示自动从账户中支付。false,表示手动从账户中支付,默认为该方式。
-
响应参数 状态码: 202 表4 响应Body参数 参数 参数类型 描述 job_id String 规格变更的任务ID,仅变更按需实例时会返回该参数。 order_id String 订单ID,仅变更包周期实例时会返回该参数。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 errCode String 业务错误码。 externalMessage String 错误信息。 状态码: 500 表6 响应Body参数 参数 参数类型 描述 errCode String 业务错误码。 externalMessage String 错误信息。
-
请求示例 变更实例规格为ddm.c6.4xlarge.2。 PUT https://{endpoint}/v3/{project_id}/instances/{instance_id}/flavor{ "spec_code" : "ddm.c6.4xlarge.2", "group_id" : "3e5a9063d3b84729b0a3310fad3a0942gr09", "is_auto_pay" : false}
-
API概览 分布式数据库 中间件所提供的接口为REST(Representational State Transfer)风格API。通过使用DDM接口,您可以使用DDM的所有功能,包括创建实例、创建逻辑库等。 表1 接口介绍 类型 接口名称 说明 DDM实例类接口 购买DDM实例 购买DDM实例。该接口创建的DDM实例为按需计费的方式。 DDM运行于虚拟私有云。申请DDM实例前,需保证有可用的虚拟私有云,并且已配置好子网与安全组。 查询DDM实例列表 查询DDM实例列表。 查询DDM实例详情 查询指定DDM实例的详细信息。 修改DDM实例名称 修改现有DDM实例的名称。 修改DDM实例安全组 修改DDM实例安全组。 删除DDM实例 删除指定的DDM实例,释放该实例的所有资源。 重启DDM实例 重启指定的DDM实例。 DDM表数据重载 DDM实例跨region容灾场景下,针对目标DDM实例实现表数据RELOAD,使数据同步。 DDM实例节点扩容 对指定的DDM实例的节点个数进行扩容。 DDM实例节点缩容 对指定的DDM实例的节点个数进行缩容。 修改DDM已关联的数据库实例的读策略 修改DDM已关联的数据库实例的读策略。 同步DN信息 同步当前DDM实例已关联的所有DN配置信息。 查询DDM实例节点列表 查询DDM实例节点列表。 查询DDM实例节点详情 查询DDM实例节点详情。 查询DDM指定实例的参数详情 查询DDM指定实例的参数详情。 修改DDM的实例参数 修改DDM实例参数。 查询DDM引擎信息 查询DDM引擎信息详情。 查询DDM可用区规格信息 查询DDM可用区规格信息详情。 变更DDM实例规格 变更DDM实例规格。 获取实例组信息列表 获取DDM实例的组信息详情。 DDM逻辑库类接口 创建DDM逻辑库 创建DDM逻辑库。 创建前需确保存在RDS实例,实例状态正常且没有被其他DDM实例关联使用。 查询DDM逻辑库列表 查询DDM逻辑库列表。 查询DDM逻辑库详细信息 查询指定逻辑库的详细信息。 删除DDM逻辑库 删除指定的逻辑库,释放该逻辑库的所有资源。 查询创建逻辑库可选取的数据库实例列表 查询创建逻辑库可选取的数据库实例列表。 DDM账号类接口 创建DDM账号 DDM账号用于连接和管理逻辑库。一个DDM账号可以关联多个逻辑库。 查询DDM账号列表 查询DDM账号列表。 修改DDM账号 修改现有DDM账号的权限或者与逻辑库的管理关系。 删除DDM账号 删除指定的DDM实例账号,如果账号关联了逻辑库,则对应的关联关系也会删除。 重置DDM账号密码 重置现有DDM账号的密码。 弱密码效验 弱密码效验。 监控管理类 慢日志监控 查询指定时间段内在DDM实例上执行过的慢SQL相关信息。 读写比例监控(即将下线) 查询指定时间段内在DDM实例的读写次数。
-
请求消息体(可选) 该部分可选。请求消息体通常以结构化格式(如JSON或XML)发出,与请求消息头中Content-Type对应,传递除请求消息头之外的内容。若请求消息体中的参数支持中文,则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于获取用户Token接口,您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示,加粗的斜体字段需要根据实际值填写,其中username为用户名,domainname为用户所属的账号名称,********为用户登录密码,xxxxxxxxxxxxxxxxxx为project的名称,如“cn-north-1”,您可以从地区和终端节点获取。 scope参数定义了Token的作用域,上面示例中获取的Token仅能访问project下的资源。您还可以设置Token的作用域为某个账号下所有资源或账号的某个project下的资源。 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”,请求鉴权信息等。 可选的附加请求头字段,如指定的URI和HTTP方法所要求的字段。详细的公共请求消息头字段请参见表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。 POST请求为可选,GET请求该字段值留空。 3495 X-Project-Id project id,项目编号。请参考获取项目ID章节获取项目编号。 否 如果是专属云场景采用AK/SK 认证方式的接口请求或者多project场景采用AK/SK认证的接口请求则该字段必选。 e9993fc787d94b6c886cbaa340f9c0f4 X-Auth-Token 用户Token。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 否 使用Token认证时该字段必选。 注:以下仅为Token示例片段 MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ API同时支持使用AK/SK认证,AK/SK认证是使用SDK对请求进行签名,签名过程会自动往请求中添加Authorization(签名认证信息)和X-Sdk-Date(请求发送的时间)请求头。 AK/SK认证的详细说明请参见AK/SK认证。
-
请求URI 请求URI由如下部分组成。 {URI-scheme} :// {Endpoint} / {resource-path} ?{query-string} 尽管请求URI包含在请求消息头中,但大多数语言或框架都要求您从请求消息中单独传递它,所有在此单独拿出来强调。 表1 URI中的参数说明 参数 描述 URI-scheme 表示用于传输请求的协议,当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器 域名 或IP,不同服务不同区域的Endpoint不同。您可以从地区和终端节点获取。 例如IAM服务在“华北-北京一”区域的Endpoint为“ddm.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示意图
-
请求方法 HTTP方法(也称为操作或动词),它告诉服务你正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源,如删除对象等。 在获取用户Token的URI部分,您可以看到其请求方法为“POST”,则其请求为: 1 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens
-
支持的授权项 策略包含系统策略和自定义策略,如果系统策略不满足授权要求,管理员可以创建自定义策略,并通过给用户组授予自定义策略来进行精细的访问控制。策略支持的操作与API相对应,授权项列表说明如下: 权限:允许或拒绝某项操作。 对应API接口:自定义策略实际调用的API接口。 授权项:自定义策略中支持的Action,在自定义策略中的Action中写入授权项,可以实现授权项对应的权限功能。 依赖的授权项:部分Action存在对其他Action的依赖,需要将依赖的Action同时写入授权项,才能实现对应的权限功能。 IAM项目(Project)/企业项目(Enterprise Project):自定义策略的授权范围,包括IAM项目与企业项目。授权范围如果同时支持IAM项目和企业项目,表示此授权项对应的自定义策略,可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目,不支持企业项目,表示仅能在IAM中给用户组授权并生效,如果在企业管理中授权,则该自定义策略不生效。关于IAM项目与企业项目的区别,详情请参见:IAM与企业管理的区别。
-
操作步骤 修改DDM实例名称。 接口相关信息 URI格式:PUT /v1/{project_id}/instances/{instance_id}/modify_name 详情请参见修改DDM实例名称。 请求示例 PUT: https://{endpoint}/v1/743b4c0428d945316666666666666666/instances/modify_name {"name": "ddm-testaa"} {endpoint}信息请从地区和终端节点获取。 响应示例 {"name":"ddm-testaa"}
-
请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务的“获取用户Token”接口来获取。 表3 请求Body参数 参数 是否必选 参数类型 描述 group_id 否 String 组ID,指定当前进行节点扩容的组。当实例的组数量大于1时,必填。 subnet_id 否 String 子网ID,当实例组下的子网ID数量大于1时,必填。 is_auto_pay 否 Boolean 对包年包月实例节点扩容时可指定,表示是否自动从账户中支付。 true,表示自动从账户中支付。 false,表示手动从账户中支付,默认为该方式。 nodes 是 Array of 表 EnlargeNodeInfo objects 节点信息列表。 最小:1 最大:实例下最大节点个数不超过32 表4 EnlargeNodeInfo 参数 是否必选 参数类型 描述 available_zone 是 String 节点可用区。取值非空,请参见地区和终端节点。
-
响应消息 正常响应参数说明 表5 响应Body参数 参数 参数类型 描述 job_id String 节点扩容任务ID。 仅按需实例节点扩容时会返回该参数。 order_id String 订单号,仅包年包月实例节点扩容时返回该参数。 正常响应示例 按需: { "job_id": "eff1d289-4d03-4942-8b9f-463ea07c000c"} 包周期: { "order_id" : " CS 1810251738L8VVD" }
-
响应示例 状态码: 200 OK { "id": "08142a7de30d40549f04fe4757c6660cpr09", "name": "ddm_69873de2-072", "description": "ParamGroup for instance", "updated" : "2021-11-09 03:26:52", "configuration_parameter" : [ { "name" : "temp_table_size_limit", "value" : "1000000", "need_restart" : "0", "read_only" : "0", "value_range" : "500000-2000000000", "data_type" : "integer", "description" : "Maximum size of the temporary table." } ], "offset" : 0, "limit" : 128, "total" : 22} 状态码: 400 bad request { "externalMessage" : "Parameter error.", "errCode" : "DBS.280001"} 状态码: 500 server error { "externalMessage" : "Server failure.", "errCode" : "DBS.200412"}
-
URI GET /v3/{project_id}/instances/{instance_id}/configurations?offset={offset}&limit={limit} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String DDM实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 索引位置,偏移量。 从第一条数据偏移offset条数据后开始查询,默认为0。 取值必须为数字,且不能为负数。 limit 否 Integer 查询个数上限值。 取值范围:1~128。 不传该参数时,默认值为10。
-
响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 updated String DDM参数最后更新时间。 configuration_parameter Array of ConfigurationParameterList objects DDM实例参数信息列表的集合。 offset Integer 分页参数: 起始值。 limit Integer 分页参数:每页多少条。 total Integer 集合总数。 id String 参数组id。 name String 参数组名称。 description String 参数组描述。 表5 ConfigurationParameterList 参数 参数类型 描述 name String 参数名称。 value String 参数值。 need_restart String 是否需要重启实例。 read_only String 参数是否只读。 value_range String 参数取值范围。 data_type String 参数类型。 description String 参数描述。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 errCode String 业务错误码。 externalMessage String 错误信息。 状态码: 500 表7 响应Body参数 参数 参数类型 描述 errCode String 业务错误码。 externalMessage String 错误信息。
更多精彩内容
CDN加速
GaussDB
文字转换成语音
免费的服务器
如何创建网站
域名网站购买
私有云桌面
云主机哪个好
域名怎么备案
手机云电脑
SSL证书申请
云点播服务器
免费OCR是什么
电脑云桌面
域名备案怎么弄
语音转文字
文字图片识别
云桌面是什么
网址安全检测
网站建设搭建
国外CDN加速
SSL免费证书申请
短信批量发送
图片OCR识别
云数据库MySQL
个人域名购买
录音转文字
扫描图片识别文字
OCR图片识别
行驶证识别
虚拟电话号码
电话呼叫中心软件
怎么制作一个网站
Email注册网站
华为VNC
图像文字识别
企业网站制作
个人网站搭建
华为云计算
免费租用云托管
云桌面云服务器
ocr文字识别免费版
HTTPS证书申请
图片文字识别转换
国外域名注册商
使用免费虚拟主机
云电脑主机多少钱
鲲鹏云手机
短信验证码平台
OCR图片文字识别
SSL证书是什么
申请企业邮箱步骤
免费的企业用邮箱
云免流搭建教程
域名价格