获取单个专属分布式存储池详情_专属分布式存储服务 DSS_API参考_API说明_华为云

(1)

API 参考

文档版本 03

发布日期 2019-07-10

(2)

非经本公司书面许可，任何单位和个人不得擅自摘抄、复制本文档内容的部分或全部，并不得以任何形式传播。

商标声明

和其他华为商标均为华为技术有限公司的商标。

本文档提及的其他所有商标或注册商标，由各自的所有人拥有。

注意

您购买的产品、服务或特性等应受华为公司商业合同和条款的约束，本文档中描述的全部或部分产品、服务或特性可能不在您的购买或使用范围之内。除非合同另有约定，华为公司对本文档内容不做任何明示或暗示的声明或保证。

由于产品版本升级或其他原因，本文档内容会不定期进行更新。除非另有约定，本文档仅作为使用指导，本文档中的所有陈述、信息和建议不构成任何明示或暗示的担保。

(3)

1 ^{使用前必读}

1.1 概述

欢迎使用专属分布式存储服务（Dedicated Distributed Storage Service，DSS）。专属分布式存储服务为您提供独享的物理存储资源，通过数据冗余和缓存加速等多项技术，提供高可用性和持久性，以及稳定的低时延性能；可灵活对接ECS、BMS以及DCC 等多种不同类型的计算服务，适用于HPC、OLAP以及混合负载等应用场景。

您可以使用本文档提供API对专属分布式存储进行相关操作，如创建、查询、删除、更新等。支持的全部操作请参见API概览。

在调用专属分布式存储服务API之前，请确保已经充分了解专属分布式存储服务相关概念，详细信息请参见《专属分布式存储服务用户指南》的“产品介绍”。

存储池申请成功后，需要在存储池中创建磁盘。磁盘API请参见云硬盘API参考。

1.2 调用说明

专属分布式存储服务提供了REST（Representational State Transfer）风格API，支持您通过HTTPS请求调用，调用方法请参见如何调用API。

1.3 终端节点（Endpoint）

终端节点（Endpoint）即调用API的请求地址，不同服务不同区域的终端节点不同，您可以从地区和终端节点中查询专属分布式存储服务的终端节点。

1.4 基本概念

● 帐号

用户注册时的帐号，帐号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于帐号是付费主体，为了确保帐号安全，建议您不要直接使用帐号进行日常管理工作，而是创建用户并使用他们进行日常管理工作。

● 用户

(5)

由帐号在IAM中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。

在我的凭证下，您可以查看帐号ID和IAM用户ID。通常在调用API的鉴权过程中，

您需要用到帐号、用户和密码等信息。

● 区域（Region）

从地理位置和网络时延维度划分，同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。Region分为通用Region和专属 Region，通用Region指面向公共租户提供通用云服务的Region；专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region。

详情请参见区域和可用区。

● 可用区（AZ，Availability Zone）

一个可用区是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。

● 项目

区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您帐号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中创建资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中资源，使得资源的权限控制更加精确。

图1-1 项目隔离模型

同样在我的凭证下，您可以查看项目ID。

● 企业项目

企业项目是项目的升级版，针对企业不同项目间资源的分组和管理，是逻辑隔离。企业项目中可以包含多个区域的资源，且项目中的资源可以迁入迁出。

关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理用户指南》。

(6)

2 ^{API 概览}

专属分布式存储提供的具体API如表2-1所示。

表2-1 API 接口

API 说明

获取单个专属分布式存储池详情

获取某个特定的专属分布式存储池详情。包括专属分布式存储池的名称、ID、容量、类型、创建时间等信息。

获取专属分布式存储池详情列表

获取租户申请的专属分布式存储池详情列表，支持过滤查询和分页查询。包括专属分布式存储池的名称、

ID、容量、类型、创建时间等信息。

获取接口版本号列表查询本服务的接口版本号列表。包括版本号、版本状态、版本发布时间等信息。

获取接口版本号详情查询本服务的接口目标版本号详情。包括版本号、版本状态、版本发布时间等信息。

磁盘相关API请参见云硬盘API参考。

(7)

3 ^{如何调用 API}

3.1 构造请求

本节介绍REST API请求的组成，并以调用IAM服务的获取用户Token说明如何调用 API，该API获取用户的Token，Token可以用于调用其他API时鉴权。

您还可以通过这个视频教程了解如何构造请求调用API：https://

bbs.huaweicloud.com/videos/102987。

请求 URI

请求URI由如下部分组成：

{URI-scheme}://{Endpoint}/{resource-path}?{query-string}

尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。

表3-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条数据。

(8)

例如您需要获取IAM在“华北-北京四”区域的Token，则需使用“华北-北京四”区域的Endpoint（iam.cn-north-4.myhuaweicloud.com），并在获取用户Token的URI部分找到resource-path（/v3/auth/tokens），拼接起来如下所示。

https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens

图3-1 URI 示意图

说明

为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。

这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

请求方法

HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。

表3-2 HTTP 方法

方法说明

GET 请求服务器返回指定资源。

PUT 请求服务器更新指定资源。

POST 请求服务器新增资源或执行特殊操作。

DELETE 请求服务器删除指定资源，如删除对象等。

HEAD 请求服务器资源头部。

PATCH 请求服务器更新资源的部分内容。

当资源不存在的时候，PATCH可能会去创建一个新的资源。

在获取用户Token的URI部分，您可以看到其请求方法为“POST”，则其请求为：

POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens

请求消息头

附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。

详细的公共请求消息头字段请参见表3-3。

(9)

表3-3 公共请求消息头

名称描述是否必选示例

Host 请求的服务器信息，从服务API的 URL中获取。值为 hostname[:port]。

端口缺省时使用默认的端口，https的默认端口为443。

否

使用AK/SK认证时该字段必选。

code.test.com or

code.test.com:443

Content-Type 消息体的类型（格式）。推荐用户使用默认值application/json，

有其他取值时会在具体接口中专门说明。

是 application/json

Content-

Length 请求body长度，单

位为Byte。否 3495

X-Project-Id project id，项目编号。请参考获取项目ID章节获取项目编号。

否

如果是专属云场景采用AK/SK认证方式的接口请求或者多project 场景采用AK/SK认证的接口请求，则该字段必选。

e9993fc787d94b6c886cb aa340f9c0f4

X-Auth-Token 用户Token。

用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。

请求响应成功后在响应消息头

（Headers）中包含的“X-Subject- Token”的值即为 Token值。

否

使用Token认证时该字段必选。

注：以下仅为Token示例片段

MIIPAgYJKoZIhvcNAQcCo ...ggg1BBIINPXsidG9rZ

说明

API同时支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。

AK/SK认证的详细说明请参见认证鉴权的“AK/SK认证”。

(10)

对于获取用户Token接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。

POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

请求消息体（可选）

该部分可选。请求消息体通常以结构化格式（如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/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。

(11)

3.2 认证鉴权

调用接口有如下两种认证方式，您可以选择其中一种进行认证鉴权。

● Token认证：通过Token认证调用请求。

● AK/SK认证：通过AK（Access Key ID）/SK（Secret Access Key）加密调用请求。

推荐使用AK/SK认证，其安全性比Token认证要高。

Token 认证

说明

Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。

Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。

Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。Token可通过调用获取用户Token接口获取。

云服务存在两种部署方式：项目级服务和全局级服务。其中：

● 项目级服务需要获取项目级别的Token，此时请求body中auth.scope的取值为 project。

● 全局级服务需要获取全局级别的Token，此时请求body中auth.scope的取值为 domain。

调用本服务API需要项目级别的Token，即调用获取用户Token接口时，请求body中 auth.scope的取值需要选择project，如下所示。

{ "auth": { "identity": { "methods": [ "password"

],

"password": { "user": {

"name": "username", "password": "********", "domain": {

"name": "domainname"

} } } }, "scope": { "project": {

"name": "xxxxxxxx"

} } } }

获取Token后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，

其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token:

ABCDEFJ....”加到请求消息头即可，如下所示。

POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/projects Content-Type: application/json

X-Auth-Token: ABCDEFJ....

(12)

您还可以通过这个视频教程了解如何使用Token认证：https://

bbs.huaweicloud.com/videos/101333。

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不同，使用时请注意。

3.3 返回结果

状态码

请求发送以后，您会收到响应，包含状态码、响应消息头和消息体。

状态码是一组从1xx到5xx的数字代码，状态码表示了请求响应的状态，完整的状态码列表请参见错误码。

对于获取用户Token接口，如果调用后返回状态码为“201”，则表示请求成功。

响应消息头

对应请求消息头，响应同样也有消息头，如“Content-type”。

对于获取用户Token接口，返回如图3-2所示的消息头，其中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

(13)

图3-2 获取用户 Token 响应消息头

响应消息体（可选）

该部分可选。响应消息体通常以结构化格式（如JSON或XML）返回，与响应消息头中 Content-Type对应，传递除响应消息头之外的内容。

对于获取用户Token接口，返回如下消息体。为篇幅起见，这里只展示部分内容。

{ "token": {

"expires_at": "2019-02-13T06:52:13.855000Z", "methods": [

"password"

],

"catalog": [ {

"endpoints": [ {

"region_id": "az-01", ...

当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。

{ "error_msg": "The format of message is error", "error_code": "AS.0001"

}

其中，error_code表示错误码，error_msg表示错误描述信息。

(14)

4 ^{API 说明}

4.1 获取单个专属分布式存储池详情

功能介绍

获取某个特定的专属分布式存储池详情。

调试

您可以在API Explorer中直接运行调试该接口。

URI

GET /v1/{project_id}/pools/{dss_id}

参数说明请参见表4-1。

表4-1 参数说明

名称是否必选参数类型说明

project_id 是 String 项目ID。

获取方法请参考获取项目ID。

dss_id 是 String 专属分布式存储池ID。

表4-2 请求参数

usage 否 Boolean 当usage=true时，返回值带有专属分布式存储池容量信息，默认为false。

(15)

请求消息

请求样例

GET https://{endpoint}/v1/{project_id}/pools/{dss_id}?usage=true

响应消息

响应参数

响应参数如表4-3所示。

表4-3 响应参数

名称参数类型说明

name String 专属分布式存储池名称。

id String 专属分布式存储池ID。

project_id String 专属分布式存储池归属的project_id。

capacity Integer 申请的专属分布式存储池容量，单位GB。

type String 专属分布式存储池的存储类型

● SAS：高IO专属分布式存储池。

● SSD：超高IO专属分布式存储池。

status String 专属分布式存储池的状态，详细信息请参考专属分布式存储池状态。

availability_zone String 专属分布式存储池所在AZ。

created_at String 专属分布式存储池的创建时间。

时间格式：UTC YYYY-MM-DDTHH:MM:SS total_capacity_gb Integer 总容量（GB）（专属分布式存储池状态为

deploying时，无该字段）。

used_capacity_gb Integer 已使用容量（GB）（专属分布式存储池状态为deploying时，无该字段）。

provisioned_capacity

_gb Integer 已分配容量（GB）（专属分布式存储池状态为deploying时，无该字段）。

max_over_subscriptio

n_ratio Float 超分比（专属分布式存储池状态为 deploying时，无该字段）。

● 响应样例

{ "name" : "dedicatedStorage01",

"id" : "c950ee97-587c-4f24-8a74-3367e3da570f", "project_id" : "63d910f2705a487ebe4e1c274748d9e1", "capacity" : 100,

"type" : "SATA",

"availability_zone" : "AZ1",

(16)

"status" : "available",

"created_at" : "2014-12-18T15:57:56.299000", "total_capacity_gb": 1000,

"used_capacity_gb": 300, "provisioned_capacity_gb":700, "max_over_subscription_ratio": 1.0 }

● 接口调用异常时，响应样例

{ "error": {

"message": "invalid dss id!", "code": "DSS.1001"

}}

返回值

● 正常 200

● 异常

请参考错误码。

错误码

4.2 获取专属分布式存储池详情列表

功能介绍

获取租户申请的专属分布式存储池详情列表，支持过滤查询和分页查询。

调试

URI

GET /v1/{project_id}/pools/detail 参数说明请参见表4-4。

表4-4 参数说明

project_id 是 String 项目ID。

获取方法请参考获取项目ID。

(17)

表4-5 请求参数

limit 否 Integer 分页查询返回结果个数限制，取值为大于0 的整数。

offset 否 Integer 分页查询起始地址，必须是正整数或0。

说明

分页查询偏移量，表示查询该偏移量后面所有的存储池。

status 否 String 专属分布式存储池的状态，例如available, deploying和extending，详细信息请参考专属分布式存储池状态。

name 否 String 专属分布式存储池的名称。

usage 否 Boolean 当usage=true时，返回值带有专属分布式存储池容量信息，默认为false。

请求消息

请求样例

GET https://{endpoint}/v1/{project_id}/pools/detail?status=available&usage=true

响应消息

响应参数

表4-6 响应参数

pools Array of objects 专属分布式存储池详情列表，详细参数说明请参见表4-7。

count Integer 专属分布式存储池个数。

返回的存储池详情数据结构

表4-7 参数说明

name String 专属分布式存储池名称。

id String 专属分布式存储池ID。

(18)

project_id String 专属分布式存储池归属的project_id。

capacity Integer 申请的专属分布式存储容量，单位TB。

type String 专属分布式存储池的存储类型。

● SAS：高IO专属分布式存储池。

● SSD：超高IO专属分布式存储池。

status String 专属分布式存储池的状态，详细信息请参考专属分布式存储池状态。

availability_zone String 专属分布式存储池所属AZ。

created_at String 专属分布式存储池的创建时间。

时间格式：UTC YYYY-MM- DDTHH:MM:SS

total_capacity_gb Integer 总容量（GB）（专属分布式存储池状态为deploying时，无该字段）。

used_capacity_gb Integer 已使用容量（GB）（专属分布式存储池状态为deploying时，无该字段）。

provisioned_capacit

y_gb Integer 已分配容量（GB）（专属分布式存储池状态为deploying时，无该字段）。

max_over_subscript

ion_ratio Float 超分比（专属分布式存储池状态为 deploying时，无该字段）。

● 响应样例

{ "pools" : [ {

"name" : "dedicatedStorage01",

"id" : "c950ee97-587c-4f24-8a74-3367e3da570f", "project_id" : "63d910f2705a487ebe4e1c274748d9e1", "capacity" : 1000,

"type" : "SATA",

"availability_zone" : "AZ1", "status" : "available",

"used_capacity_gb": 300, "provisioned_capacity_gb":700, "max_over_subscription_ratio": 1.0 },

{ "name" : "dedicatedStorage02",

"id" : "6edbc2f4-1507-44f8-ac0d-eed1d2608d38", "project_id" : "63d910f2705a487ebe4e1c274748d9e1", "capacity" : 1000,

"type" : "SATA",

"availability_zone" : "AZ1", "status" : "available",

"used_capacity_gb": 300, "provisioned_capacity_gb":700, "max_over_subscription_ratio": 1.0

(19)

} ] , "count": 2 }

● 接口调用异常时，错误响应样例

{ "error": {

"message": "invalid filter limit!", "code": "DSS.1003"

}}

返回值

● 正常 200

● 异常

错误码

4.3 查询所有磁盘详情

请参考云硬盘API查询所有云硬盘详情。

4.4 获取接口版本号列表

功能介绍

查询本服务的接口版本号列表。

调试

URI

GET /

请求消息

● 请求参数无

● 请求样例

本示例展示了查询当前API所有版本信息。

GET https://{endpoint}/

响应消息

响应参数

(20)

表4-8 响应参数

参数名称类型说明

versions Array 描述version 相关对象的列表。

id String 版本ID（版本号），如v1。

links Array of

objects API的URL地址，详细信息请参考表4-9。

version String 该版本API支持的最大微版本。

status String 版本状态，为如下3种：

CURRENT：表示该版本为当前推荐使用的版本。

SUPPORTED：表示为老版本，目前还在继续维护。

DEPRECATED：表示为废弃版本，已不再维护，

存在后续删除的可能。

updated String 版本发布时间。

时间格式：UTC YYYY-MM-DDTHH:MM:SS min_version String 该版本API 支持的最小微版本。

links参数信息

links参数信息说明如表4-9所示。

表4-9 参数说明

参数名参数类型说明

rel String 链接的描述。

href String 版本号查询链接。

● 响应样例

{ "versions": [ {

"min_version": "", "links": [ {

"rel": "self",

"href": "https://dss.localdomain.com/v1"

} ], "id": "v1",

"updated": "2014-06-28T12:20:21Z", "version": "",

(21)

"status": "SUPPORTED"

}, {

"min_version": "", "links": [

{

"rel": "self",

} ], "id": "v2",

"status": "CURRENT"

} ] }

返回值

● 正常 200

● 异常

错误码

4.5 获取接口版本号详情

功能介绍

查询本服务的接口目标版本号详情。

调试

URI

GET /{api_version}

参数说明请参见表4-10。

表4-10 参数说明

api_version 是 String 目标版本号。

获取版本号请参考获取接口版本号列表。

(22)

请求消息

● 请求参数无

● 请求样例

本示例展示了查询v1版本API的版本信息。

GET https://{endpoint}/v1

响应消息

响应参数

表4-11 响应参数

参数名称类型说明

version Object 描述version 相关对象的列表。

id String 版本ID（版本号），如v1。

links Array API的URL地址，详细信息请参考表4-12。

version String 该版本API支持的最大微版本。

status String 版本状态，为如下3种：

CURRENT：表示该版本为当前推荐使用的版本。

SUPPORTED：表示为老版本，目前还在继续维护。

DEPRECATED：表示为废弃版本，已不再维护，

存在后续删除的可能。

updated String 版本发布时间。

时间格式：UTC YYYY-MM-DDTHH:MM:SS min_version String 该版本API 支持的最小微版本。

links参数信息

links参数信息说明如表4-12所示。

表4-12 参数说明

参数名参数类型说明

rel String 链接的描述。

href String 版本号查询链接。

(23)

● 响应样例

{ "version": {

"min_version": "", "links": [ {

"rel": "self",

} ], "id": "v1",

"status": "CURRENT"

} }

返回值

● 正常 200

● 异常

错误码

(24)

5 ^{权限和授权项}

5.1 权限及授权项说明

如果您需要对您所拥有的专属分布式存储服务（Dedicated Distributed Storage Service，DSS）进行精细的权限管理，您可以使用统一身份认证服务（Identity and Access Management，简称IAM），如果华为云帐号已经能满足您的要求，不需要创建独立的IAM用户，您可以跳过本章节，不影响您使用DSS服务的其它功能。

默认情况下，新建的IAM用户没有任何权限，您需要将其加入用户组，并给用户组授予策略或角色，才能使用户组中的用户获得相应的权限，这一过程称为授权。授权后，用户就可以基于已有权限对云服务进行操作。

权限根据授权的精细程度，分为角色和策略。角色以服务为粒度，是IAM最初提供的一种根据用户的工作职能定义权限的粗粒度授权机制。策略以API接口为粒度进行权限拆分，授权更加精细，可以精确到某个操作、资源和条件，能够满足企业对权限最小化的安全管控要求。

说明

如果您要允许或是禁止某个接口的操作权限，请使用策略。

帐号具备所有接口的调用权限，如果使用帐号下的IAM用户发起API请求时，该IAM用户必须具备调用该接口所需的权限，否则，API请求将调用失败。每个接口所需要的权限，与各个接口所对应的授权项相对应，只有发起请求的用户被授予授权项所对应的策略，该用户才能成功调用该接口。例如，用户要调用接口来查询云服务器列表，那么这个IAM用户被授予的策略中必须包含允许“ecs:servers:list”的授权项，该接口才能调用成功。

支持的授权项

策略包含系统策略和自定义策略，如果系统策略不满足授权要求，管理员可以创建自定义策略，并通过给用户组授予自定义策略来进行精细的访问控制。策略支持的操作与API相对应，授权项列表说明如下：

● 权限：允许或拒绝某项操作。

● 对应API接口：自定义策略实际调用的API接口。

● 授权项：自定义策略中支持的Action，在自定义策略中的Action中写入授权项，

可以实现授权项对应的权限功能。

(25)

● 依赖的授权项：部分Action存在对其他Action的依赖，需要将依赖的Action同时写入授权项，才能实现对应的权限功能。

● IAM项目(Project)/企业项目(Enterprise Project)：自定义策略的授权范围，包括 IAM项目与企业项目。授权范围如果同时支持IAM项目和企业项目，表示此授权项对应的自定义策略，可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目，不支持企业项目，表示仅能在IAM中给用户组授权并生效，如果在企业管理中授权，则该自定义策略不生效。关于IAM项目与企业项目的区别，详情请参见：IAM与企业管理的区别。

专属分布式存储服务（Dedicated Distributed Storage Service，DSS）支持的自定义策略授权项如下所示：

● 专属分布式存储池管理，包含专属分布式存储池接口对应的授权项，如查询某个

特定的专属分布式存储池详情和专属分布式存储池详情列表。

● 磁盘管理，包含磁盘接口对应的授权项，如查询所有磁盘详情。

5.2 专属分布式存储池管理

权限对应API接口授权项

（Action

）

IAM项目 (Project)

企业项目 (Enterpri seProject) 查询专属分布式

存储池

GET /v1/{project_id}/

pools/{dss_id} dss.action.

querypool √ √ 查询专属分布式

存储池详情列表

pools/detail dss.action.l

istpools √ √

5.3 磁盘管理

权限对应API接口授权项

（Action

）

IAM项目 (Project)

企业项目 (Enterpri seProject) 查询所有云硬盘

详情

cloudvolumes/detail evs:volume

s:list √ √

(26)

A ^附录

A.1 专属分布式存储池状态

表A-1 专属分布式存储池状态

专属分布式存储池状态说明

available 专属分布式存储池处于可用状态。

deploying 专属分布式存储池处于正在部署的过程

中，不可使用。

extending 专属分布式存储池处于正在扩容的过程

中，可使用。

A.2 错误码

当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。

错误码

状态码错误

码错误信息描述处理措施

400 DSS.

0001 invalid project id! URI中租户ID非法。使用合法的project id。

400 DSS.

0002 invalid token! HTTP请求Header参数

错误。使用合法的token。

400 DSS.

0003 invalid token roles! 租户传入的令牌

(token)错误。确认是否拥有相应的角色，没有则加上。

(27)

状态码

错误码

错误信息描述处理措施

400 DSS.

1001 invalid dss id! 专属分布式存储池ID非法。

修改专属分布式存储 ID格式。

400 DSS.

1002 invalid dss name! 查询专属分布式存储池 URL中name的参数错误。

修改专属分布式存储 name格式。

400 DSS.

1003 invalid filter limit! 查询专属分布式存储的池URL中limit参数错误。

查询时，过滤条件 limit必须为大于0的整数。

400 DSS.

1004 invalid filter offset! 查询专属分布式存储池详情URL中offset的参数错误。

检查请求中的offset 是否有效。

400 DSS.

1005 invalid filter

usage! 查询专属分布式存储池详情URL中usage的参数错误。

检查请求中的usage 是否有效。

400 DSS.

1006 api roles is null or

empty! 用户权限错误。添加对应的用户权

限。

400 DSS.

1007 User role is not allowed for this action!

用户无权限执行对应操

作。添加对应的用户权

限。

400 DSS.

1008 Type conversion error , parameter type is unexpected

类型转换错误，参数类型未知。

参数转换失败，请检查输入参数是否正确。

400 DSS.

1009 url encoding

failed! 类型转换错误。参数转换失败，请检查输入参数是否正确。

500 DSS.

1010 internal error! 系统暂时异常。具体原因请联系技术支持。

A.3 状态码

● 正常

错误码状态描述

200 OK

201 Created

202 Accepted 204 No Content

(28)

● 异常

错误码状态描述

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 413 overLimit 415 badMediaType 500 Internal Server Error 501 Not Implemented 502 Bad Gateway 503 Service Unavailable 504 Gateway Timeout

A.4 获取项目 ID

操作场景

在调用接口的时候，部分URL中需要填入项目ID，所以需要获取到项目ID。有如下两种获取方式：

● 调用API获取项目ID

● 从控制台获取项目ID

调用 API 获取项目 ID

项目ID可以通过调用查询指定条件下的项目列表API获取。

获取项目ID的接口为“GET https://{Endpoint}/v3/projects”，其中{Endpoint}为IAM 的终端节点，可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。

响应示例如下，其中projects下的“id”即为项目ID。

{ "projects": [

(29)

{

"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"

} }

从控制台获取项目 ID

从控制台获取项目ID的步骤如下：

1. 登录管理控制台。

2. 鼠标悬停在右上角的用户名，选择下拉列表中的“我的凭证”。

在“API凭证”页面的项目列表中查看项目ID。

图A-1 查看项目 ID

A.5 API 授权项列表

API API功能 授权项

GET /v1/{project_id}/pools/

{dss_id} 获取某个特定的专属分布式存储池

详情。 dss:pools:get

GET /v1/{project_id}/pools/

detail 对租户开放查询专属分布式存储池

列表详情接口，返回租户申请的专属分布式存储池列表详情。

dss:pools:list

(30)

B ^修订记录

发布日期变更说明

2019-07-10 第三次发布。

● 更新API参考文档模板3.0。

● 新增“权限和授权项”。

2018-10-30 第二次发布。

API说明中新增“获取版本号列表”和“获取单个版本号详情”。

2018-03-30 第一次发布。

获取单个专属分布式存储池详情_专属分布式存储服务 DSS_API参考_API说明_华为云

API 参考

目 录

1 使用前必读... 1

2 API 概览... 3

3 如何调用 API...4

4 API 说明... 11

5 权限和授权项...21

A 附录... 23

B 修订记录... 27

1 使用前必读

1.1 概述

1.2 调用说明

1.3 终端节点（Endpoint）

1.4 基本概念

2 API 概览

3 如何调用 API

3.1 构造请求

请求 URI

请求方法

请求消息头

请求消息体（可选）

username

domainname

********

xxxxxxxxxxxxxxxxxx

3.2 认证鉴权

Token 认证

AK/SK 认证

3.3 返回结果

状态码

响应消息头

响应消息体（可选）

4 API 说明

4.1 获取单个专属分布式存储池详情

功能介绍

调试

URI

请求消息

响应消息

返回值

错误码

4.2 获取专属分布式存储池详情列表

功能介绍

调试

URI

请求消息

响应消息

返回值

错误码

4.3 查询所有磁盘详情

4.4 获取接口版本号列表

功能介绍

调试

URI

请求消息

响应消息

返回值

错误码

4.5 获取接口版本号详情

功能介绍

调试

URI

请求消息

响应消息

返回值

错误码

5 权限和授权项

5.1 权限及授权项说明

支持的授权项

5.2 专属分布式存储池管理

5.3 磁盘管理

A 附录

A.1 专属分布式存储池状态

A.2 错误码

错误码

A.3 状态码

A.4 获取项目 ID

操作场景

调用 API 获取项目 ID

目录

1 ^{使用前必读}

2 ^{API 概览}

3 ^{如何调用 API}

4 ^{API 说明}

5 ^{权限和授权项}

A ^附录

B ^修订记录