华为云用户手册

响应消息 正常响应要素说明 表2 参数说明 参数 参数类型 描述 configurations Array of objects 参数模板信息，具体参数请参考表3。 count Integer 总记录数。 表3 configurations字段数据结构说明 参数 参数类型 描述 id String 参数组ID。 name String 参数组名称。 description String 参数组描述。 datastore_version String 引擎版本。 datastore_name String 引擎名称。 ha_mode String 实例类型。 created String 创建时间，格式为"yyyy-MM-dd HH:mm:ss"。 updated String 更新时间，格式为"yyyy-MM-dd HH:mm:ss"。 user_defined Boolean 是否是用户自定义参数模板： false，表示为系统默认参数模板。 true，表示为用户自定义参数模板。 正常响应样例 参数模板列表： { "count": 3, "configurations": [ { "id": "b000d7c91f1749da87315700793a11d4pr14", "name": "Default-Enterprise-Edition-GaussDB-1.0-INDEP", "description": "Default parameter template for Enterprise Edition GaussDB 1.0-Independent", "created": "2022-03-23 07:20:11", "updated": "2022-03-23 07:20:11", "datastore_version": "1.0", "datastore_name": "GaussDB(for openGauss)", "ha_mode": "enterprise", "user_defined": false }, { "id": "8d99f260ea1b4493a1b349e7abce5c09pr14", "name": "Default-Enterprise-Edition-GaussDB-1.1-INDEP", "description": "Default parameter template for Enterprise Edition GaussDB 1.1-Independent", "created": "2022-03-23 07:20:11", "updated": "2022-03-23 07:20:11", "datastore_version": "1.1", "datastore_name": "GaussDB(for openGauss)", "ha_mode": "enterprise", "user_defined": false }, { "id": "0f44b65521a8414d8b8811df810d94ccpr14", "name": "Default-Enterprise-Edition-GaussDB-1.2-INDEP", "description": "Default parameter template for Enterprise Edition GaussDB 1.2-Independent", "created": "2022-03-23 07:20:11", "updated": "2022-03-23 07:20:11", "datastore_version": "1.2", "datastore_name": "GaussDB(for openGauss)", "ha_mode": "enterprise", "user_defined": false }]}

URI URI格式 GET https://{Endpoint}/v3/{project_id}/configurations?offset={offset}&limit={limit} URI样例 https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/054b61972980d4552f0bc00ac8d3f5cd/configurations?offset=1&limit=3 参数说明 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 offset 否 Integer 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。例如：该参数指定为0，limit指定为10，则只展示第1-10条数据。 limit 否 Integer 查询记录数。默认为100，不能为负数，最小值为1，最大值为100。例如该参数设定为10，则查询结果最多只显示10条记录。

URI URI格式 GET https://{Endpoint}/v3.1/{project_id}/flavors?limit={limit}&offset={offset}&ha_mode={ha_mode}&version={version}&spec_code={spec_code} URI样例 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/flavors?offset=0&limit=10&ha_mode=centralization_standard&version=3.100&spec_code=gaussdb.opengauss.ee.dn.m6.2xlarge.8.in 参数说明 表1 参数说明 名称 是否必选 参数类型 说明 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 version 否 String 数据库版本号。查询指定版本支持的规格。例如1.4 spec_code 否 String 规格编码，查询指定规格编码的具体规格信息。 ha_mode 否 String 实例类型，查询指定实例类型支持的规格。 集中式：centralization_standard 分布式：enterprise limit 否 Integer 查询记录数。默认为100，不能为负数，最小值为1，最大值为100。例如该参数设定为10，则查询结果最多只显示10条记录。 offset 否 Integer 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。例如：该参数指定为1，limit指定为10，则只展示第2-11条数据。

URI URI格式 GET https://{Endpoint}/v3/{project_id}/recycle-instances URI样例 https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/recycle-instances 参数说明 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_name 否 String 实例名称。 offset 否 Integer 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。例如：该参数指定为0，limit指定为10，则只展示第1-10条数据。 limit 否 Integer 查询记录数。默认为50，不能为负数，最小值为1，最大值为50。例如该参数设定为10，则查询结果最多只显示10条记录。

响应消息 正常响应要素说明 表2 参数说明 参数 参数类型 描述 instances Array of objects 回收站所有的实例信息，具体参数请参考表3。 total_count Integer 总记录数。 表3 instances字段数据结构说明 参数 参数类型 描述 id String 实例ID。 name String 实例名称。 ha_mode String 部署形态。 枚举值： Ha Independent engine_version String 引擎版本号。 pay_model String 计费模式（0：按需计费；1：包年/包月）。 枚举值： 0 1 created_at String 创建时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 deleted_at String 删除时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 volume_type String 磁盘类型。（SAS：high；SSD：ultrahigh；ESSD：essd）。 枚举值： high ultrahigh essd data_vip String 数据vip。 enterprise_project_id String 企业项目ID，"0"代表默认的企业项目。 recycle_backup_id String 备份ID。（指删除实例时产生备份信息中的备份ID）。 recycle_status String 回收站备份状态。（Running：运行中；Active：有效的）。 枚举值： Running Active mode String 实例类型（basic：基础版；standard：标准版；enterprise：企业版）。 枚举值： basic standard enterprise 正常响应样例 参数模板列表： { "total_count" : 2, "instances" : [ { "id" : "21f20e55999947a9938ad0453b757e72in14", "name" : "gaussdbv5_CCv20_bms_default_1_20220827012852", "ha_mode" : "Ha", "engine_version" : "2.3.0", "pay_model" : 0, "created_at" : "2022-08-09T09:26:44.000+08:00", "deleted_at" : "2022-08-09T09:26:44.000+08:00", "volume_type" : "localssd", "data_vip" : "25.213.0.41 / 25.213.0.188 / 25.213.0.101 / 25.213.0.82", "enterprise_project_id" : 0, "recycle_backup_id" : "00b755ed678e41d18c74b28e2ad41bdcbr14", "recycle_status" : "Active", "mode" : "enterprise" }, { "id" : "a9df5b52b32e4571b1b6425a78a32956in14", "name" : "ecs-lxy-backup-3", "ha_mode" : "Ha", "engine_version" : "2.3.0", "pay_model" : 0, "created_at" : "2022-08-09T09:26:44.000+08:00", "deleted_at" : "2022-08-09T09:26:44.000+08:00", "volume_type" : "ultrahigh", "data_vip" : "173.202.10.246 / 173.202.10.205 / 173.202.10.175", "enterprise_project_id" : 0, "recycle_backup_id" : "ef393704ef0045d1b6226b6f2cdc48a7br14", "recycle_status" : "Active", "mode" : "enterprise" } ] }

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 tasks Array of objects 任务列表。 详情请参见表3 tasks字段数据结构说明。 total_count Integer 任务数量。 表3 tasks字段数据结构说明 名称 参数类型 说明 instance_info Object 任务绑定的实例信息。 详情请参见表4 instance_info字段数据结构说明。 job_id String 任务ID。 name String 任务名称。 status String 任务状态。 process String 任务进度，单位：%。 fail_reason String 失败原因。 表4 instance_info字段数据结构说明 名称 参数类型 说明 instance_id String 实例ID。 instance_name String 实例名称。 instance_status String 实例状态。

URI URI格式 GET https://{Endpoint}/v3/{project_id}/tasks URI样例 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/tasks?status=Running&name=CreateGaussDBV5Instance&offset=1&limit=10 参数说明 表1 参数说明 名称 是否必选 参数类型 说明 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 status 否 String 任务状态。 Running：运行中 Completed：完成 Failed：失败 name 否 String 任务名称。 CreateGaussDBV5Instance：创建实例 BackupSnapshotGaussDBV5InInstance：手动创建备份 CloneGaussDBV5NewInstance：恢复到新实例 RestoreGaussDBV5InInstance：恢复到当前实例 RestoreGaussDBV5InInstanceToExistedInst：恢复到已有实例 DeleteGaussDBV5Instance：删除实例 EnlargeGaussDBV5Volume：磁盘扩容 ResizeGaussDBV5Flavor：规格变更 GaussDBV5ExpandClusterCN：协调节点扩容 GaussDBV5ExpandClusterDN：分片扩容 start_time 否 String 开始时间。 end_time 否 String 结束时间。 offset 否 Integer 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 limit 否 Integer 查询记录数。默认为100，不能为负数，最小值为1，最大值为100

URI URI格式 GET https://{Endpoint}/v3/{project_id}/enterprise-projects/quotas URI样例 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/enterprise-projects/quotas 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 enterprise_project_id 否 String 企业项目ID。 - 对于未开通企业多项目服务的用户，不传该参数。 - 对于已开通企业多项目服务的用户，不传该参数时，表示为default企业项目。 offset 否 Integer 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。例如：该参数指定为0，limit指定为10，则只展示第1-10条数据。 limit 否 Integer 查询记录数。默认为100，不能为负数，最小值为1，最大值为100。例如该参数设定为10，则查询结果最多只显示10条记录。

响应消息 正常响应要素说明 表1 参数说明 名称 参数类型 说明 eps_quotas Array of objects 企业项目详情列表。 详情请参见表2。 total_count Integer 总记录数。 表2 eps_quotas字段数据结构说明 名称 参数类型 说明 enterprise_project_id String 企业项目ID。 enterprise_project_name String 企业项目名称。 instance_eps_quota Integer EPS实例资源配额数量，值为-1时表示配额无限制。 vcpus_eps_quota Integer EPS计算资源配额数量，值为-1时表示配额无限制。 ram_eps_quota Integer EPS内存资源配额量，单位为GB，值为-1时表示配额无限制。 volume_eps_quota Integer EPS磁盘资源配额量，单位为GB，值为-1时表示配额无限制。 instance_used Integer EPS实例使用数量。 vcpus_used Integer EPS计算资源使用数量。 ram_used Integer EPS内存使用配额量，单位为GB。 volume_used Integer EPS磁盘使用配额量，单位为GB。 正常响应样例 { "eps_quotas" : [ { "enterprise_project_id" : "2c049d98-3347-494f-8767-99af6b3aa5f0", "enterprise_project_name" : "default", "instance_eps_quota" : 100, "vcpus_eps_quota" : 1500, "ram_eps_quota" : 20000, "volume_eps_quota" : 100000, "instance_used" : 33, "vcpus_used" : 1460, "ram_used" : 19680, "volume_used" : 8840 }, { "enterprise_project_id" : "2c049d98-3347-494f-8767-99af6b3aa5f0", "enterprise_project_name" : "11111", "instance_eps_quota" : -1, "vcpus_eps_quota" : -1, "ram_eps_quota" : -1, "volume_eps_quota" : -1, "instance_used" : 2, "vcpus_used" : 54, "ram_used" : 384, "volume_used" : 680 }, { "enterprise_project_id" : "bd91e1eb-2e33-4f17-a8d4-05eb2c805781", "enterprise_project_name" : "quota_at_gaussdbv5_test", "instance_eps_quota" : -1, "vcpus_eps_quota" : -1, "ram_eps_quota" : -1, "volume_eps_quota" : -1, "instance_used" : 1, "vcpus_used" : 240, "ram_used" : 1920, "volume_used" : 480 } ], "total_count" : 3 }

请求消息 参数说明 表2 参数说明 名称 是否必选 参数类型 说明 eps_quotas 是 Array of objects 需要修改的企业配额列表。 表3。 表3 EpsQuotasOption参数说明 名称 是否必选 参数类型 说明 enterprise_projects_id 是 String 企业项目Id。 instance_quota 否 Integer 实例的配额。取值范围：实际创建的实例个数 ~ 100,000。 vcpus_quota 否 Integer cpu的配额。取值范围：实际使用的cpu核数 ~ 2,147,483,646。 ram_quota 否 Integer 内存的配额。单位GB。取值范围：实际使用的内存 ~ 2,147,483,646。 volume_quota 否 Integer 存储空间的配额。单位：GB。取值范围：实际使用的存储空间 ~ 2,147,483,646。

URI URI格式 PUT https://{Endpoint}/v3/{project_id}/enterprise-projects/quotas URI样例 https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/054b61972980d4552f0bc00ac8d3f5cd/enterprise-projects/quotas 参数说明 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。

请求示例 修改企业项目配额，实例的配额设置为1000个，cpu配额100000核数，内存配额200000GB，存储空间配额1000000GB。 { "eps_quotas" : [ { "enterprise_projects_id" : "0", "instance_quota" : 1000, "vcpus_quota" : 100000, "ram_quota" : 200000, "volume_quota" : 1000000 } ]}

请求消息 参数说明 表2 参数说明 名称 是否必选 参数类型 说明 tags 是 Array of objects 需要添加的用户标签列表。 详情请参见表3。 表3 tags参数说明 名称 是否必选 参数类型 说明 key 是 String 标签键。最大长度36个unicode字符，不能为null或者空字符串，不能为空格，校验和使用之前会自动过滤掉前后空格。 value 是 String 标签值。最大长度43个unicode字符，可以为空字符串，不能为空格，校验和使用之前会自动过滤掉前后空格。

URI URI格式 POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/tags URI样例 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/tags 参数说明 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String 实例ID。

URI URI格式 DELETE https://{Endpoint}/v3/{project_id}/jobs/{job_id} URI样例 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/jobs/6b00c41d-d54f-4bcb-80da-566ccedc2b5d 参数说明 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 job_id 是 String 任务id。

URI URI格式 GET https://{Endpoint}/v3/{project_id}/recycle-policy URI样例 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/recycle-policy 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一region下的project ID。 获取方法请参见获取项目ID。

响应消息 正常响应要素说明 表2 参数说明 参数 参数类型 描述 tags Array of objects 标签列表。 详情请参见表3。 表3 tags字段数据结构说明 参数 参数类型 描述 key String 标签键。最大长度36个unicode字符，key不能为空。 字符集：0-9，A-Z，a-z，“_”，“-”，中文。 value Array of strings 标签值。最大长度43个unicode字符，可以为空字符串。 字符集：0-9，A-Z，a-z，“_”，“.”，“-”，中文。 正常响应样例 标签列表： { "tags" : [ { "key" : "key1", "value" : [ "value1", "value2" ] }, { "key" : "key2", "value" : [ "value2", "value3" ] } ]} 异常响应 请参见异常请求结果。

URI URI格式 GET https://{Endpoint}/v3/{project_id}/tags URI样例 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/tags 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一region下的project ID。 获取方法请参见获取项目ID。

URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/volume-usage URI样例 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/volume-usage 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 实例ID。

响应消息 正常响应要素说明 表2 参数说明 参数 参数类型 描述 tags Array of objects 用户标签列表。 详情请参见表3。 total_count Integer 总记录数。 表3 tags字段数据结构说明 参数 参数类型 描述 key String 标签键。最大长度36个unicode字符，key不能为空。 字符集：0-9，A-Z，a-z，“_”，“-”，中文。 value Array of strings 标签值。最大长度43个unicode字符，可以为空字符串。 字符集：0-9，A-Z，a-z，“_”，“.”，“-”，中文。 正常响应样例 标签列表： { "tags" : [ { "key" : "key1", "value" : [ "value1", "value2" ] }, { "key" : "key2", "value" : [ "value2", "value3" ] } ], "total_count": 2}

URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/tags URI样例 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/tags 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 实例ID。

URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/available-flavors URI样例 https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/054b61972980d4552f0bc00ac8d3f5cd/instances/dsfae23fsfdsae3435in14/available-flavors 参数说明 表1 参数说明 名称 是否必选 参数类型 说明 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String 实例ID。 limit 否 Integer 查询记录数。默认为100，不能为负数，最小值为1，最大值为100。例如该参数设定为10，则查询结果最多只显示10条记录。 offset 否 Integer 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。例如：该参数指定为1，limit指定为10，则只展示第2-11条数据。

URI URI格式 GET https://{Endpoint}/v3/{project_id}/instance-snapshot?instance_id={instance_id}&backup_id={backup_id}&restore_time={restore_time} URI样例 https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/054b61972980d4552f0bc00ac8d3f5cd/instance-snapshot 参数说明 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 否 String 原实例ID。根据时间点恢复实例时，需要同时填写instance_id和restore_time。 restore_time 否 String 根据时间点恢复实例时，需要同时填写instance_id和restore_time。 UNIX时间戳格式，单位是毫秒，时区是UTC，某时间点实例的信息。 backup_id 否 String 备份ID。 根据备份ID恢复实例时，需要填写该参数。

响应消息 正常响应要素说明 表2 参数说明 参数 参数类型 描述 cluster_mode String 实例部署形态。集中式Ha(主备)、分布式Independent(独立部署)。 枚举值： Ha Independent instance_mode String 实例模型，企业版enterprise，标准版standard，基础版basic。 枚举值： basic standard enterprise data_volume_size String 磁盘大小，单位：GB。 solution String 解决方案模板类型。集中式Ha一般用triset，分布式Independent一般为空或者默认hws。 描述如下： triset：高可用(1主2备) hws：默认。 枚举值： triset hws node_num Integer 节点数量。 coordinator_num Integer 协调节点数量。 sharding_num Integer 分片数量。 replica_num Integer 副本数量。 engine_version String 引擎版本。 正常响应样例 参数模板列表： { "cluster_mode" : "Ha", "instance_mode" : "enterprise", "data_volume_size" : "200", "solution" : "triset", "node_num" : 3, "coordinator_num" : 0, "sharding_num" : 3, "replica_num" : 3, "engine_version" : "2.2.90"}

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 instances Array of Objects 返回可用于备份恢复的实例列表。 详情请参见instances参数数据结构说明。 total_count Integer 查询出来的实例总数。 表3 instances参数数据结构说明 名称 参数类型 说明 instance_name String 实例名称。 instance_id String 实例id。 volume_type String 存储类型。 data_volume_size Number 磁盘大小，单位：GB。 version Number 实例版本信息。 mode String 部署形态。 Ha：主备版 Independent：独立部署 instance_mode String 实例模型。 enterprise：企业版 standard：标准版 basic：基础版

URI URI格式 GET https://{Endpoint}/v3/{project_id}/restorable-instances URI样例 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/restorable-instances?source_instance_id=88efb3753dc844829c380edff7798eecin14&backup_id=d3f223e9c35d450ea0692bdbff686e45br14 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一region下的project ID。 获取方法请参见获取项目ID。 source_instance_id 是 源实例ID，需要恢复的实例ID。 backup_id 否 实例备份信息ID，根据备份ID查询实例拓扑信息，过滤查询出来的实例，包含节点数，副本数等。参数为空时，根据restore_time查询。 restore_time 否 恢复点，当备份ID为空时，通过此参数查询实例拓扑信息，过滤实例列表。 offset 否 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 limit 否 查询记录数。默认为100，不能为负数，最小值为1，最大值为100。

URI URI格式 POST https://{Endpoint}/gaussdb/v3/{project_id}/instances/{instance_id}/password URI样例 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/opengauss/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/password 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 实例ID。

请求消息体（可选） 该部分可选。请求消息体通常以结构化格式（如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 请求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在同一个区域也相同，所以简洁起见将这两部分省略。

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源，如删除对象等。 在获取用户Token的URI部分，您可以看到其请求方法为“POST”，则其请求为： 1 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens