DescribeNamespaces - 查看项目空间详情

您可以调用DescribeNamespaces查询某实例下的项目空间信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
stream:DescribeVvpNamespaces
*全部资源
*

请求参数

名称类型必填描述示例值
Regionstring

地域。

cn-beijing
InstanceIdstring

订单实例 ID。

f-cn-wwo36qj4g06
Namespacestring

项目空间名称。

di-590843445844225
Tagsarray<object>

标签列表。

object

标签。

Keystring

标签键。

Flink
Valuestring

标签值。

test
PageIndexinteger

当前页数

1
PageSizeinteger

每页大小

10

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

67F33190-946B-1105-B6A1-E2DF0426DD51
Successboolean

是否成功,取值如下:

  • true:成功。
  • false:失败。
true
TotalCountlong

总条数

5
TotalPageinteger

总页数

2
PageIndexinteger

当前页数。

1
PageSizeinteger

设置的每页行数。

10
Namespacesarray<object>

项目空间列表

namespace列表object

项目空间的信息。

Namespacestring

项目空间的名称。

ns-1
Statusstring

项目空间的状态,取值如下:

  • CREATING:正在创建。
  • DELETING:正在删除。
  • MODIFYING:正在修改资源规格。
  • SUCCESS:上一个操作执行成功。
  • FAILED:上一个操作执行失败。
SUCCESS
GmtCreatelong

创建时间。

1629879567394
GmtModifiedlong

修改时间。

1629879567394
ResourceSpecobject

资源规格信息

Cpuinteger

CPU 数量。

10
MemoryGBinteger

内存大小。

40
ResourceUsedobject

已使用的资源。

Cpufloat

已使用的 CPU 数量。

2
MemoryGBfloat

已使用的内存数量。

4
Tagsarray<object>

标签列表。

tag信息object

标签

Keystring

标签键

flink
Valuestring

标签值

test

示例

正常返回示例

JSON格式

{
  "RequestId": "67F33190-946B-1105-B6A1-E2DF0426DD51",
  "Success": true,
  "TotalCount": 5,
  "TotalPage": 2,
  "PageIndex": 1,
  "PageSize": 10,
  "Namespaces": [
    {
      "Namespace": "ns-1",
      "Status": "SUCCESS",
      "GmtCreate": 1629879567394,
      "GmtModified": 1629879567394,
      "ResourceSpec": {
        "Cpu": 10,
        "MemoryGB": 40
      },
      "GuaranteedResourceSpec": {
        "Cpu": 0,
        "MemoryGB": 0
      },
      "ElasticResourceSpec": {
        "Cpu": 0,
        "MemoryGB": 0
      },
      "ResourceUsed": {
        "Cpu": 2,
        "MemoryGB": 4,
        "Cu": 0
      },
      "Tags": [
        {
          "Key": "flink",
          "Value": "test"
        }
      ],
      "Ha": true
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-03-07OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情