ListNamespaces - 查询命名空间列表

展示命名空间列表,同时可以展示出每个命名空间下的在线节点数和总应用数。此外,该接口也可以按照命名空间名称进行模糊查询。

调试

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

授权信息

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

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

请求参数

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

地域。

cn-hangzhou
PageNumberinteger

页码。

1
PageSizeinteger

每页展示条数

10
Namestring

需要模糊查询的命名空间名,不填则默认查询所有。

myNamespace
AcceptLanguagestring

返回结果显示的语言。取值:zh(默认值):中文,en:英文

zh

返回参数

名称类型描述示例值
object

RestResult<PageResult>

RequestIdstring

请求 ID。

D1F1A6F3-7E03-5EAD-B3F1-123456789ABC
Dataobject

返回结果。

PageNumberinteger

结果页码。

1
TotalSizeinteger

查询结果总条数。

7
PageSizeinteger

查询时分页大小。

10
Resultarray<object>

返回结果。

Resultobject

返回集合。

UserIdstring

用户 id。

178*******
Regionstring

地域。

cn-hangzhou
Namespacestring

命名空间。

myNamespace
Versioninteger

版本。基础版 0,专业版 1,企业版 2。

1
Describestring

命名空间描述。

测试命名空间1。
InstanceCountlong

在线节点数

6
AppCountinteger

应用数。

3
CreateTimelong

创建时间。

2024-09-02T09:49:48.000+0000
UpdateTimelong

更新时间。

2024-09-02T09:49:48.000+0000
Resultsarray<object>

返回结果集。

Resultobject

返回集合。

UserIdstring

用户 id。

178*******
Regionstring

地域。

cn-hangzhou
Namespacestring

命名空间。

myNamespace
Versioninteger

版本。基础版 0,专业版 1,企业版 2。

1
Describestring

命名空间描述。

测试命名空间1。
InstanceCountlong

在线节点数。

6
AppCountinteger

应用数。

3
CreateTimelong

创建时间。

2024-09-02T09:49:48.000+0000
UpdateTimelong

更新时间。

2024-09-02T09:49:48.000+0000

示例

正常返回示例

JSON格式

{
  "RequestId": "D1F1A6F3-7E03-5EAD-B3F1-123456789ABC",
  "Data": {
    "PageNumber": 1,
    "TotalSize": 7,
    "PageSize": 10,
    "Result": [
      {
        "UserId": "178*******",
        "Region": "cn-hangzhou",
        "Namespace": "myNamespace",
        "Version": 1,
        "Describe": "测试命名空间1。",
        "InstanceCount": 6,
        "AppCount": 3,
        "CreateTime": 0,
        "UpdateTime": 0
      }
    ],
    "Results": [
      {
        "UserId": "178*******",
        "Region": "cn-hangzhou",
        "Namespace": "myNamespace",
        "Version": 1,
        "Describe": "测试命名空间1。",
        "InstanceCount": 6,
        "AppCount": 3,
        "CreateTime": 0,
        "UpdateTime": 0
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400IllegalRequestInvalid request:%s非法请求: %s
400InvalidParameterParameter error:%s请求参数错误:%s
403NoPermissionYou are not authorized to perform this operation:%s没有权限使用此接口:%s
404NotFoundNot found:%s资源不存在:%s
500InternalErrorConsole error. Try again later:%s控制台错误.稍后重试:%s

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