查询专属资源列表 - QueryingDedicatedResources

功能介绍

查询用户创建的专属资源列表。

接口约束

该接口支持GeminiDB Cassandra数据库实例。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
gaussdbfornosql:instance:listExclusiveResource
List
-
-
-
-

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
gaussdbfornosql:instance:listExclusiveResource	List	-	-	-	-

URI

GET /v3/{project_id}/dedicated-resources

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：租户在某一region下的project ID。获取方法请参见获取项目ID。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。

表2 Query参数
参数	是否必选	参数类型	描述
offset	否	Integer	参数解释：索引位置偏移量，表示从指定project ID下最新的专属资源创建时间开始，按时间的先后顺序偏移offset条数据后查询对应的专属资源信息。约束限制：大于或等于0。取值范围：不涉及。默认取值：不传该参数时，查询偏移量默认为0，表示从最新的创建时间对应的专属资源开始查询。
limit	否	Integer	参数解释：查询专属资源个数上限值。约束限制：不涉及。取值范围： 1~100。默认取值：不传该参数时，默认查询前100条实例信息。

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
x-auth-token	是	String	参数解释：用户Token。通过调用IAM服务获取用户Token接口获取。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。

响应参数

状态码： 200

表4 响应Body参数
参数	参数类型	描述
total_count	Integer	参数解释：总记录数。取值范围：不涉及。
resources	Array of DedicatedResource objects	参数解释：专属资源信息列表。取值范围：不涉及。

表5 DedicatedResource
参数	参数类型	描述
id	String	参数解释：专属资源ID。取值范围：不涉及。
resource_name	String	参数解释：专属资源的名称。取值范围：不涉及。
engine_name	String	参数解释：接口名称。取值范围：不涉及。
availability_zone	String	参数解释：可用区信息。取值范围：不涉及。
architecture	String	参数解释：专属资源中计算主机的类型。取值范围： X86：表示x86规格； ARM：表示鲲鹏规格。
capacity	DedicatedResourceCapacity object	参数解释：专属资源的容量信息。取值范围：不涉及。
status	String	参数解释：专属资源的状态信息。取值范围： NORMAL：可用。 BUILDING：建设中。

表6 DedicatedResourceCapacity
参数	参数类型	描述
vcpus	Integer	参数解释： CPU核数。取值范围：不涉及。
ram	Integer	参数解释：内存大小，单位GB。取值范围：不涉及。
volume	Integer	参数解释：存储大小，单位GB。取值范围：不涉及。

请求示例

URI样例

GET https://gaussdb-nosql.cn-north-4.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/dedicated-resources?offset=0&limit=10

响应示例

状态码： 200

Success

{
  "total_count" : 2,
  "resources" : [ {
    "id" : "300acc71-eca9-4c6b-9a4e-0d25e20fe54c",
    "resource_name" : "nosql-dedicated-resource-1",
    "engine_name" : "cassandra",
    "availability_zone" : "az1,az2,az3",
    "architecture" : "X86",
    "capacity" : {
      "vcpus" : 192,
      "ram" : 1536,
      "volume" : 300000
    },
    "status" : "NORMAL"
  }, {
    "id" : "4c423cd8-551f-4b74-934f-8534e4a9bf2b",
    "resource_name" : "nosql-dedicated-resource-2",
    "engine_name" : "cassandra",
    "availability_zone" : "az1,az2,az3",
    "architecture" : "X86",
    "capacity" : {
      "vcpus" : 192,
      "ram" : 1536,
      "volume" : 300000
    },
    "status" : "BUILDING"
  } ]
}