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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeNamespaces

系统规定参数。取值为DescribeNamespaces。

DescribeNamespacesRequest Object

查询项目空间信息的请求参数。

Region String cn-beijing

工作空间所属的地域ID。

InstanceId String 223493C7-FCA9-13D4-B75B-AF8B32F4****

工作空间ID。

Namespace String ns-1

项目空间名称。

PageIndex Integer 1

工作空间状态列表的页码。

起始值为1。

PageSize Integer 10

分页查询时设置的每页行数。

最大值为100。

返回数据

名称 类型 示例值 描述
RequestId String 67F33190-946B-1105-B6A1-E2DF0426DD51

请求ID。

Success Boolean true

是否成功,取值如下:

  • true:成功。
  • false:失败。
TotalCount Long 15

所查询到的项目空间总个数。

TotalPage Integer 2

查询到的项目空间总页数。

PageIndex Integer 1

当前页数。

PageSize Integer 10

输入时设置的每页行数。

Namespaces Array of namespace列表

项目空间的信息数组。

Namespace String ns-1

项目空间的名称。

Status String SUCCESS

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

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

创建时间。

GmtModified Long 1629879567394

修改时间。

ResourceSpec Object

资源规格。

Cpu Integer 10

CPU数量。

MemoryGB Integer 40

设置的内存数量。

ResourceUsed Object

已使用的资源。

Cpu Float 2.5

已使用的CPU数量。

MemoryGB Float 6.6

已使用的内存数量。

Cu Float 1.6

已经使用的CU用量。计算公式为MAX(CPU, MemoryGB/4)。

Tags Array of tag资源

资源列表。

Key String flink

标签键。

Value String test

标签值。

示例

请求示例

http(s)://{Endpoint}/?Action=DescribeNamespaces
&DescribeNamespacesRequest={"Region":"cn-beijing","InstanceId":"223493C7-FCA9-13D4-B75B-AF8B32F4****","Namespace":"ns-1","PageIndex":1,"PageSize":10}
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeNamespacesResponse>
    <RequestId>67F33190-946B-1105-B6A1-E2DF0426DD51</RequestId>
    <Success>true</Success>
    <TotalCount>15</TotalCount>
    <TotalPage>2</TotalPage>
    <PageIndex>1</PageIndex>
    <PageSize>10</PageSize>
    <Namespaces>
        <Namespace>ns-1</Namespace>
        <Status>SUCCESS</Status>
        <GmtCreate>1629879567394</GmtCreate>
        <GmtModified>1629879567394</GmtModified>
        <ResourceSpec>
            <Cpu>10</Cpu>
            <MemoryGB>40</MemoryGB>
        </ResourceSpec>
        <ResourceUsed>
            <Cpu>2.5</Cpu>
            <MemoryGB>6.6</MemoryGB>
            <Cu>1.6</Cu>
        </ResourceUsed>
        <Tags>
            <Key>flink</Key>
            <Value>test</Value>
        </Tags>
    </Namespaces>
</DescribeNamespacesResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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