华为云用户手册

请求示例 使用备份文件将数据恢复到实例。 POST https://{endpoint}/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/recovery { "source": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01", "type": "backup", "backup_id": "2f4ddb93-b901-4b08-93d8-1d2e472f30fe" }, "target": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01" } } 使用SQL Server备份文件将所有数据库恢复到实例。 { "source": { "instance_id": "61879e6085bc44d1831b0ce62d988fd9in04", "type": "backup", "backup_id": "b021670e69ba4538b7b2ed07257306aebr04", "restore_all_database":true }, "target": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin04" } } 将实例的数据恢复到指定时间点。 { "source": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01", "type": "timestamp", "restore_time": 1532001446987 }, "target": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01" } } 将SQL Server实例的部分数据库恢复到指定时间点。 { "source": { "instance_id": "61879e6085bc44d1831b0ce62d988fd9in04", "type": "timestamp", "restore_time": 1532001446987, "database_name": { "db1": "dbtest1,dbtest2", "db2": "db2,db02", "db3": "" } }, "target": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin04" } }

请求示例 更新实例的跨区域自动全量备份策略。 PUT https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/backups/offsite-policy { "policy_para": { "backup_type": "auto", "keep_days": 7, "destination_region": "aaa", "destination_project_id": "ba1f7fc8-3307-42a7-aa6f-42c8b9b8f85c" } } 关闭实例的跨区域自动全量备份策略。 { "policy_para": { "backup_type": "auto", "keep_days": 0, "destination_region": "aaa", "destination_project_id": "ba1f7fc8-3307-42a7-aa6f-42c8b9b8f85c" } } 更新SQL Server实例的跨区域备份策略。 { "policy_para": { "backup_type": "all", "keep_days": 7, "destination_region": "aaa", "destination_project_id": "ba1f7fc8-3307-42a7-aa6f-42c8b9b8f85c" } } 关闭SQL Server实例的跨区域备份策略。 { "policy_para": { "backup_type": "all", "keep_days": 0, "destination_region": "aaa", "destination_project_id": "ba1f7fc8-3307-42a7-aa6f-42c8b9b8f85c" } }

接口约束 如果实例已开启跨区域备份策略，调用接口设置跨区域备份策略，仅会更改保留天数，其他参数设置无效。 RDS for PostgreSQL自动全量备份和自动增量备份保留天数必须保持一致。 RDS for PostgreSQL自动增量备份必须在开启自动全量备份后才能开启。 RDS for PostgreSQL自动全量备份和自动增量备份都开启后，关闭时请按顺序依次关闭自动增量备份、自动全量备份。 RDS for PostgreSQL选择卷快照备份方式的实例不支持跨区域备份。

请求消息 表2 参数说明 名称 是否必选 参数类型 说明 policy_para 是 Object 备份策略对象，包括备份类型、备份保留天数、目标区域ID和目标project ID。 详情请参见表3。 表3 policy_para字段数据结构说明 名称 是否必选 参数类型 说明 backup_type 是 String 指定备份的类型。 RDS for SQL Server仅支持设置为“all”。 取值如下： auto：自动全量备份。 incremental：自动增量备份。 all：同时设置所有备份类型。 RDS for MySQL：同时设置自动全量和自动增量备份。 RDS for PostgreSQL：同时设置自动全量和自动增量备份。 RDS for SQL Server：同时设置自动全量、自动增量备份和手动备份。 keep_days 是 Integer 指定已生成的备份文件可以保存的天数。 取值范围：0～1825。 保存天数设置为0时，表示关闭跨区域备份策略。 须知： 关闭备份策略后，备份任务将立即停止，如果有增量备份，所有增量备份任务将立即删除，使用增量备份的相关操作可能失败，相关操作不限于下载、复制、恢复、重建等，请谨慎操作。 destination_region 是 String 设置跨区域备份策略的目标区域ID。 destination_project_id 是 String 设置跨区域备份策略的目标project ID。

请求示例 解除实例容灾关系。 DELETE https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/42d4b4fc17d144bbb3ba64a306e68c72in03/delete-disaster-recovery { "target_instance_id" : "8c08eda627cc4344aca26832c87ff16cin03", "target_project_id" : "0ddd1dbcb3494d3dbdb614b39104760b", "target_region" : "cn-southwest-244", "target_ip" : "192.168.2.70", "is_master" : true }

请求消息 表1 参数说明 名称 是否必选 参数类型 说明 target_instance_id 是 String 解除目标的实例ID。 target_project_id 是 String 解除目标的项目 ID。 target_region 是 String 解除目标的region。 target_ip 是 String 解除目标的数据浮动IP。 is_master 是 Boolean 当前操作对象是否是主实例。 值为“true”，表示当前是主实例。 值为“false”，表示当前是灾备实例。

URI URI格式 GET /v3/{project_id}/instances/{instance_id}/database/db_user?db-name={db-name}&page={page}&limit={limit} 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 instance_id 是 实例ID。 db-name 是 数据库名。 page 是 分页页码，从1开始。 limit 是 每页数据条数。取值范围[1, 100]。

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 users Array of objects 列表中每个元素表示一个数据库账号。 详情请参见表3。 total_count Integer 数据库用户总数。 表3 users元素结构说明 名称 参数类型 说明 name String 账号名。 readonly Boolean 是否为只读权限： true表示只读。 false表示可读写。 正常响应样例 { "users": [ { "name": "rds", "readonly": false }, { "name": "rds001", "readonly": false } ], "total_count": 2 } 异常响应 请参见异常请求结果。

请求示例 生成审计日志下载链接。 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/cee5265e1e5845649e354841234567dfin01/auditlog-links { "ids": ["fa163e9970a3t11e9d834e122fdceb1d6br01", "fa163ea0e2bet11e9d8364943103c94c5br01"] }

响应消息 正常响应要素说明 表3 要素说明 名称 参数类型 说明 links Array of strings 审计日志下载链接列表，有效时间5分钟。 正常响应样例 { "links": ["https://obs.domainname.com/rdsbucket.username.1/xxxxxx", "https://obs.domainname.com/rdsbucket.username.2/xxxxxx"] } 异常响应 请参见异常请求结果。

响应消息 正常响应要素说明 表3 要素说明 名称 参数类型 说明 records List 停止结果记录。 详情请参见表4。 表4 records字段说明 名称 参数类型 说明 instance_id String 实例ID。 job_id String 任务ID。 正常响应样例 { "records": [ { "instance_id": "5b409baece064984a1b3eef6addae50cin01", "job_id": "2b414788a6004883a02390e2eb0ea227" } ] } 异常响应 请参见异常请求结果。

接口约束 如需批量停止实例，请联系客服申请。 最多支持批量停止50个实例。 该接口仅支持MySQL引擎。 仅支持停止存储类型为超高IO、SSD云盘、极速型SSD的按需实例，专属云RDS不支持停止实例。 已停止的实例被删除后不会进入回收站。 停止主实例时，如果存在只读实例，会同时停止只读实例。不支持单独停止只读实例。对于华东-上海一区域，主实例和只读实例均默认停止十五天。对于除华东-上海一外的其他区域，主实例和只读实例均默认停止七天。 对于华东-上海一区域，实例默认停止十五天，如果您在十五天后未手动开启实例，数据库实例将于十五天后的下一个可维护时间段内自动启动。 对于除华东-上海一外的其他区域，实例默认停止七天，如果您在七天后未手动开启实例，数据库实例将于七天后的下一个可维护时间段内自动启动。 实例停止后，虚拟机（VM）停止收费，其余资源包括弹性公网IP（EIP）、存储资源、备份正常计费。 实例在以下状态不能执行停止实例： 创建、重启、扩容、变更规格、恢复、修改端口等不能进行此操作。

响应消息 正常响应要素说明 表7 要素说明 名称 参数类型 说明 restore_result Array of objects 表信息。详细说明请参见表8。 表8 restore_result字段数据结构说明 参数 参数类型 描述 instance_id String 实例ID。 job_id String 工作流ID。 正常响应样例 { "restore_result" : [ { "instance_id" : "df29b535eec64ee1b286bd2c62871a9cin03", "job_id" : "749d6254-f4f0-4f72-aa32-876e220d2496" } ] } 异常响应 请参见异常请求结果。

请求消息 参数说明 表2 参数说明 名称 是否必选 参数类型 说明 instances 否 Array of objects 表信息。详细说明请参见表3。 表3 instances字段数据结构说明 名称 是否必选 参数类型 说明 restore_time 否 Long 恢复时间。 instance_id 否 String 实例ID。 databases 否 Array of objects 数据库信息。详细说明请参见表4。 表4 databases字段数据结构说明 名称 是否必选 参数类型 说明 database 否 String 数据库名。 schemas 否 Array of objects 模式信息。详细说明请参见表5。 表5 schemas字段数据结构说明 名称 是否必选 参数类型 说明 schema 否 String 模式信息。 tables 否 Array of objects 表信息。详细说明请参见表6。 表6 tables字段数据结构说明 名称 是否必选 参数类型 说明 old_name 否 String 恢复前表名。 new_name 否 String 恢复后表名。 请求样例 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/batch/restore/tables { "instances": [{ "restore_time": 1688556737000, "instance_id": "df29b535eec64ee1b286bd2c62871a9cin03", "databases": [{ "database": "data1", "schemas": [{ "schema": "schema1", "tables": [{ "old_name": "table1", "new_name": "table1_1688556737000" }] }], }] }] }

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 instance_id String 实例ID。 tde_status String TDE开启状态。 枚举值： open：已开启 close：关闭中 正常响应样例 { "instance_id":"3d39c18788b54a919bab633874c159dfin04", "tde_status":"open" } 异常响应 请参见异常请求结果。

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 backups Array of objects 参数解释： 备份列表。 详情请参见表3。 total_count Integer 参数解释： 总记录数。 取值范围： 不涉及。 表3 backups字段数据结构说明 名称 参数类型 说明 id String 参数解释： 备份ID。 取值范围： 不涉及。 name String 参数解释： 备份名字。 取值范围： 不涉及。 type String 参数解释： 备份类型。 取值范围： auto：自动全量备份。 manual：手动全量备份。 fragment：差异全量备份。 incremental：自动增量备份。对于RDS for MySQL为Binlog备份。 size Long 参数解释： 备份大小，单位：KB。 取值范围： 不涉及。 status String 参数解释： 备份状态。 取值范围： BUILDING：备份中。 COMPLETED：备份完成。 FAILED：备份失败。 DELETING：备份删除中。 begin_time String 参数解释： 备份开始时间。 全量备份类型下，指备份开始时间。 MySQL增量备份类型，指备份文件中上一轮增备任务的最后一个事务的提交时间。 取值范围： 格式为“yyyy-mm-ddThh:mm:ssZ”。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 end_time String 参数解释： 备份结束时间。 全量备份类型下，指备份结束时间。 MySQL增量备份类型，指备份文件中最后一个事务的提交时间。 取值范围： 格式为“yyyy-mm-ddThh:mm:ssZ”，其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 datastore Object 参数解释： 数据库版本信息。 详情请参见表4。 databases Array of objects 参数解释： 用户自建库，仅Microsoft SQL Server的局部备份。 详情请参见表5。 instance_id String 参数解释： 备份所在实例ID。 取值范围： 不涉及。 associated_with_ddm Boolean 参数解释： 是否已被DDM实例关联。 取值范围： false：表示未被DDM实例关联。 true：表示被DDM实例关联。 表4 datastore字段数据结构说明 名称 参数类型 说明 type String 参数解释： 数据库引擎。 取值范围： 不区分大小写。 MySQL PostgreSQL SQLServer version String 参数解释： 数据库版本。 取值范围： 不涉及。 表5 databases字段数据结构说明 名称 参数类型 说明 name String 参数解释： 用户自建数据库名。 取值范围： 不涉及。 正常响应样例 RDS for MySQ L实例 ： { "backups": [{ "id": "43e4feaab48f11e89039fa163ebaa7e4br01", "name": "xxxx.xxx", "type": "auto", "size": 2803, "status": "COMPLETED", "begin_time": "2018-08-06T12:41:14+0800", "end_time": "2018-08-06T12:43:14+0800", "datastore": { "type": "MySQL", "version": "5.7" }, "instance_id": "a48e43ff268f4c0e879652d65e63d0fbin01", "associated_with_ddm": false }], "total_count": 1 } RDS for PostgreSQL实例： { "backups": [{ "id": "43e4feaab48f11e89039fa163ebaa7e4br03", "name": "xxxx.xxx", "type": "incremental", "size": 2803, "status": "COMPLETED", "begin_time": "2018-08-06T12:41:14+0800", "end_time": "2018-08-06T12:43:14+0800", "datastore": { "type": "PostgreSQL", "version": "1" }, "instance_id": "a48e43ff268f4c0e879652d65e63d0fbin03 ", "associated_with_ddm": false }], "total_count": 1 } RDS for SQL Server实例： { "backups": [{ "id ": "43e4feaab48f11e89039fa163ebaa7e4br04", "name": "xxxx.xxx", "type": "manual", "size": 2803, "status": "COMPLETED", "begin_time": "2018-08-06T12:41:14+0800", "end_time": "2018-08-06T12:43:14+0800", "datastore": { "type": "SQLServer", "version": "2014_WEB" }, "databases": [{ "name": "user01" }, { "name": "user02" }], "instance_id": "a48e43ff268f4c0e879652d65e63d0fbin04", "associated_with_ddm": false }], "total_count": 1 } 异常响应 请参见异常请求结果。

请求消息 请求参数 无。 URI样例 GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/backups?instance_id=43e4feaab48f11e89039fa163ebaa7e4in01&backup_id=c0c9f155c7b7423a9d30f0175998b63bbr01&backup_type=auto&offset=0&limit=10&begin_time=2018-08-06T10:41:14+0800&end_time=2018-08-16T10:41:14+0800

URI URI格式 GET /v3/{project_id}/backups?instance_id={instance_id}&backup_id={backup_id}&backup_type={backup_type}&offset={offset}&limit={limit}&begin_time={begin _time}&end_time={end_time} 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 instance_id 是 参数解释： 实例ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 backup_id 否 参数解释： 备份ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 backup_type 否 参数解释： 备份类型。 约束限制： 不涉及。 取值范围： auto：自动全量备份。 manual：手动全量备份。 fragment：差异全量备份。 incremental：自动增量备份。对于RDS for MySQL为Binlog备份。 默认取值： 不涉及。 status 否 参数解释： 备份状态，只支持筛选RDS for SQL Server的全量备份的状态。 约束限制： 不涉及。 取值范围： BUILDING：备份中。 COMPLETED：备份完成。 FAILED：备份失败。 默认取值： 不涉及。 offset 否 参数解释： 索引位置，偏移量。 约束限制： 从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 取值范围： 大于等于0的整数。 默认取值： 0 limit 否 参数解释： 查询记录数。 约束限制： 不能为负数。 取值范围： 最小值为1，最大值为100。 默认取值： 100 begin_time 否 参数解释： 查询开始时间。 约束限制： “begin_time”有值时，“end_time”必选。 取值范围： 格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 默认取值： 不涉及。 end_time 否 参数解释： 查询结束时间。 约束限制： “end_time”有值时，“begin_time”必选。 取值范围： 格式为“yyyy-mm-ddThh:mm:ssZ”，且大于查询开始时间。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 默认取值： 不涉及。

请求消息 参数说明 表2 参数说明 参数 是否必选 参数类型 描述 period_type 是 String 参数解释： 周期类型。 约束限制： 不涉及。 取值范围： MONTH：月 YEAR：年 默认取值： 不涉及。 period_num 是 int 参数解释： 周期数。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 auto_pay_policy 否 String 参数解释： 是否自动支付。 约束限制： 不涉及。 取值范围： YES：自动扣费 NO：手动支付（默认） 默认取值： NO auto_renew_policy 否 String 参数解释： 是否到期自动续期。 约束限制： 不涉及。 取值范围： YES：自动续费 NO：不自动续费（默认） 默认取值： NO URI样例 POST https://rds.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/49b9dd1d6f464ba4bc91df5cbd2e52ebin03/to-period 请求示例 RDS实例按需转包周期。 { "period_type" : "MONTH", "period_num" : 6, "auto_pay_policy" : "NO", "auto_renew_policy" : "NO" }

URI URI格式 POST /v3/{project_id}/instances/{instance_id}/to-period 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 instance_id 是 参数解释： 实例ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 databases Array of objects 列表中每个元素表示一个数据库。 详情请参见表3。 表3 databases元素结构说明 名称 参数类型 说明 name String 数据库名称。 character_set String 数据库使用的字符集，例如utf8、gbk、ascii等。 users Array of objects 列表中每个元素表示一个与数据库关联的账号。 详情请参见表4。 表4 users元素结构说明 名称 参数类型 说明 name String 账号名。 readonly Boolean 是否为只读权限： true表示只读。 false表示可读写。 正常响应样例 { "databases": [ { "name": "rds-test", "character_set": "utf8", "users": [ { "name": "rds", "readonly": false } ] }, { "name": "testdb1", "character_set": "utf8", "users": [] }, { "name": "tt", "character_set": "utf8", "users": [] } ] } 异常响应 请参见异常请求结果。

请求消息 请求参数 表2 参数说明 名称 参数类型 是否必选 说明 target_version String 是 目标版本。 URI样例 https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/3aa441c4c98a4b36b100a7e3e87d17cein03/major-version/inspection { "target_version": "14.9.0" }

URI URI格式 GET /v3/{project_id}/flavors/{database_name}?version_name={version_name}&spec_code={spec_code}&is_serverless={is_serverless} 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 database_name 是 参数解释： 数据库引擎名。 约束限制： 不涉及。 取值范围： MySQL PostgreSQL SQLServer 默认取值： 不涉及。 version_name 否 参数解释： 数据库版本号，获取方法请参见查询数据库引擎的版本。（可输入小版本号） 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 is_serverless 否 参数解释： 是否查询Serverless规格。 约束限制： 不涉及。 取值范围： true：查询Serverless规格。 false：查询非Serverless规格。 默认取值： false spec_code 否 参数解释： 规格编码。 说明： RDS for MySQL规格码请参见云数据库 RDS for MySQL实例类型。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

请求消息 表2 参数说明 名称 是否必选 参数类型 说明 keep_days 是 Integer 审计日志保存天数，取值范围0~732。 取值0，表示关闭审计日志策略。 取值1~732，表示开启审计日志策略，并设置审计日志保存天数为该值。 reserve_auditlogs 否 Boolean 仅关闭审计日志策略时有效。 true（默认），表示关闭审计日志策略的同时，延迟删除已有的历史审计日志。 false，表示关闭审计日志策略的同时，删除已有的历史审计日志。 audit_types 否 Array of strings 该参数仅针对RDS for MySQL引擎。 审计日志的操作类型，仅打开审计日志策略时有效。参数值为空时，默认为全部操作类型。 CREATE_USER,DROP_USER,RENAME_USER,GRANT,REVOKE,ALTER_USER,ALTER_USER_DEFAULT_ROLE CREATE,ALTER,DROP,RENAME,TRUNCATE,REPAIR,OPTIMIZE INSERT,DELETE,UPDATE,REPLACE,SELECT BEGIN/COMMIT/ROLLBACK,PREPARED_STATEMENT,CALL_PROCEDURE,KILL,SET_OPTION,CHANGE_DB,UNINSTALL_PLUGIN,INSTALL_PLUGIN,SHUTDOWN,SLAVE_START,SLAVE_STOP,LOCK_TABLES,UNLOCK_TABLES,FLUSH,XA

请求示例 设置审计日志保存5天。 PUT https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/cee5265e1e5845649e354841234567dfin01/auditlog-policy { "keep_days":5, "audit_types": [ "CREATE_USER" ] } 关闭审计日志策略，同时删除已有的历史审计日志。 { "keep_days":0, "reserve_auditlogs":false }

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 database_limit Integer 参数解释： 每次返回的库上限数量。 取值范围： 不涉及。 total_tables Integer 参数解释： 返回的总表数量。 取值范围： 不涉及。 table_limit Integer 参数解释： 每次返回的表上限数量。 取值范围： 不涉及。 databases Array of objects 参数解释： 可恢复到主实例的数据库列表。 详情请参见表3。 表3 databases字段数据结构说明 名称 参数类型 说明 name String 参数解释： 数据库名称。 取值范围： 不涉及。 total_tables Integer 参数解释： 返回该库下的总表数量。 取值范围： 不涉及。 schemas Array of objects 参数解释： 该库下的schema列表。 详情请参见表4。 表4 schemas字段数据结构说明 名称 参数类型 说明 name String 参数解释： schema名称。 取值范围： 不涉及。 total_tables Integer 参数解释： 返回该schema下的总表数量。 取值范围： 不涉及。 tables Array of objects 参数解释： 该schema下的表列表。 详情请参见表5。 表5 tables字段数据结构说明 名称 参数类型 说明 name String 参数解释： 表名称。 取值范围： 不涉及。 正常响应样例 { "databases" : [ { "name" : "postgres", "schemas" : [ ], "total_tables" : 0 } ], "database_limit" : 2000, "table_limit" : 20000, "total_tables" : 0 } 异常响应 请参见异常请求结果。

URI URI格式 GET /v3/{project_id}/instances/{instance_id}/log-replay/database 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 instance_id 是 参数解释： 要查询的实例ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

请求消息头 附加请求头字段，如指定的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章节获取项目编号。 否 如果是专属云场景采用AK/SK 认证方式的接口请求或者多project场景采用AK/SK认证的接口请求则该字段必选。 e9993fc787d94b6c886cbaa340f9c0f4 X-Auth-Token 用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 否 使用Token认证时该字段必选。 注：以下仅为Token示例片段 MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ API同时支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 AK/SK认证的详细说明请参见认证鉴权的“AK/SK认证”。 对于获取用户Token接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。 1 2 POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

请求消息体（可选） 该部分可选。请求消息体通常以结构化格式（如JSON或XML）发出，与请求消息头中Content-Type对应，传递除请求消息头之外的内容。若请求消息体中的参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，domainname为用户所属的账号名称，********为用户登录密码，xxxxxxxxxxxxxxxxxx为project的名称，如“cn-north-4”，您可以从地区和终端节点获取。 scope参数定义了Token的作用域，上面示例中获取的Token仅能访问project下的资源。您还可以设置Token的作用域为某个账号下所有资源或账号的某个project下的资源，详细定义请参见获取用户Token。 POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens Content-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 请求URI由如下部分组成： {URI-scheme}://{Endpoint}/{resource-path}?{query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 表1 URI中的参数说明 参数 描述 URI-scheme 表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器 域名 或IP，不同服务不同区域的Endpoint不同，您可以从地区和终端节点获取。 例如 IAM 服务在“华北-北京四”区域的Endpoint为“iam.cn-north-4.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-4.myhuaweicloud.com），并在获取用户Token的URI部分找到resource-path（/v3/auth/tokens），拼接起来如下所示。 1 https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。