ListAnsServices_微服务引擎_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

说明 当前的 OpenAPI 并非是 Nacos-SDK API,Nacos-SDK API 相关内容,请参见官方文档

流控信息

请求速率为100/1(s)。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
mse:ListAnsServices
List
全部资源
*

请求参数

字段名称字段详情
ServiceNamestring

服务名称。

示例值:name参考取值来源:
    CreateNacosService
    GetServiceList
    ListEurekaServices
    InitializeServiceLinkRole
GroupNamestring

联系人组名称。

示例值:name参考取值来源:
    ListSecurityGroup
NamespaceIdstring

命名空间 ID。

示例值:12233****参考取值来源:
    CreateEngineNamespace
ClusterNamestring

查询服务下某个集群的实例列表时所需要的参数。

示例值:DEFAULT参考取值来源:
    QueryClusterDetail
    ListClusters
    GetGovernanceKubernetesCluster
HasIpCountstring

是否查询服务实例数量。

示例值:true枚举值:falsetrue
deprecatedClusterIdstring

集群 ID。展开详情

示例值:mse-09k1q11****
InstanceIdstring

实例 ID。展开详情

示例值:mse-cn-st21v5****参考取值来源:
    ListAnsInstances
    CreateNacosInstance
PageNuminteger<int32>

页码。

示例值:1
PageSizeinteger<int32>

每页展示实例数。

示例值:10
RegionIdstring

地域。

示例值:cn-hangzhou
RequestParsstring

扩展请求参数,JSON 格式。

示例值:{}
AcceptLanguagestring

返回信息的语言类型:展开详情

示例值:zh

返回参数

字段名称字段详情
HttpCodestring

HTTP 状态码。

示例值:202
TotalCountinteger<int32>

实例总数。

示例值:7
RequestIdstring

请求 ID。

示例值:52BA6DA6-A702-4362-A32F-DFF79655****
Messagestring

信息。

示例值:请求处理成功
PageSizeinteger<int32>

每页展示实例数。

示例值:10
PageNumberinteger<int32>

页码。

示例值:1
Dataarray<object>

数据概览。

ErrorCodestring

错误码。

示例值:mse-100-000
Successboolean

请求结果,取值如下:展开详情

示例值:true

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
OperationNotSupport
The current cluster does not support this operation, %s.诊断
400
IllegalRequest
Invalid request:%s诊断
400
InvalidParameter
Parameter error:%s诊断
403
NoPermission
You are not authorized to perform this operation:%s诊断
404
NotFound
Not found:%s诊断
500
InternalError
Console error. Try again later:%s诊断

变更历史

变更时间变更内容概要操作
2025-04-15
新增错误码400
2024-06-27
变更请求参数ClusterId
变更请求参数InstanceId

相关示例