ListNamespaces - 查询命名空间列表_微服务引擎(MSE)-阿里云帮助中心

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

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

mse:ListNamespaces

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
Region	string	是	地域。	cn-hangzhou
PageNumber	integer	否	分页查询页码。	1
PageSize	integer	否	分页查询时每页展示条数。默认为 5，如需返回更多数据，请将该值向上调整。	10
Name	string	否	需要模糊查询的命名空间名，不填则默认查询所有。	myNamespace
Tag	array	否	阿里云标签。
	object	否	标签列表，最多包含 20 个子项。
Key	string	否	标签键。	key
Value	string	否	标签值。	value
AcceptLanguage	string	否	返回结果显示的语言。取值：zh（默认值）：中文，en：英文	zh

返回参数

名称	类型	描述	示例值
	object	RestResult<PageResult>
RequestId	string	请求 ID。	D1F1A6F3-7E03-5EAD-B3F1-123456789ABC
Data	object	返回结果。
PageNumber	integer	结果页码。	1
TotalSize	integer	查询结果总条数。	7
PageSize	integer	查询时分页大小。	10
Result	array	返回结果。
	object	返回集合。
UserId	string	用户 id。	178*******
Region	string	地域。	cn-hangzhou
Namespace	string	命名空间。	myNamespace
Version	integer	版本。基础版 0，专业版 1，企业版 2。	1
Describe	string	命名空间描述。	测试命名空间1。
InstanceCount	integer	在线节点数。	6
AppCount	integer	应用数。	3
CreateTime	integer	创建时间。	2024-09-02T09:49:48.000+0000
UpdateTime	integer	更新时间。	2024-09-02T09:49:48.000+0000
Tags	object	阿里云标签。	{"1":"1","2":"2"}
Results	array	返回结果集。
	object	返回集合。
UserId	string	用户 id。	178*******
Region	string	地域。	cn-hangzhou
Namespace	string	命名空间。	myNamespace
Version	integer	版本。基础版 0，专业版 1，企业版 2。	1
Describe	string	命名空间描述。	测试命名空间1。
InstanceCount	integer	在线节点数。	6
AppCount	integer	应用数。	3
CreateTime	integer	创建时间。	2024-09-02T09:49:48.000+0000
UpdateTime	integer	更新时间。	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,
        "Tags": {
          "1": "1",
          "2": "2"
        }
      }
    ],
    "Results": [
      {
        "UserId": "178*******",
        "Region": "cn-hangzhou",
        "Namespace": "myNamespace",
        "Version": 1,
        "Describe": "测试命名空间1。",
        "InstanceCount": 6,
        "AppCount": 3,
        "CreateTime": 0,
        "UpdateTime": 0
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	IllegalRequest	Invalid request:%s	非法请求： %s
400	InvalidParameter	Parameter error:%s	请求参数错误：%s
500	InternalError	Console error. Try again later:%s	控制台错误.稍后重试：%s
403	NoPermission	You are not authorized to perform this operation:%s	没有权限使用此接口：%s
404	NotFound	Not found:%s	资源不存在：%s

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

变更历史

更多信息，参考变更详情。