首页 >企业级分布式应用服务 EDAS >API参考 >API目录 >服务管理 >GetServiceListPage - 查询微服务列表

GetServiceListPage - 查询微服务列表

调用GetServiceListPage接口获取服务列表。

调试

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

调试

授权信息

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

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

    请求参数

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

    地域。

    cn-hangzhou
    namespacestring

    命名空间。

    cn-hangzhou:doc-test
    originstring

    数据来源,取值如下:

    • agent:新版服务查询需要传递。
    • registry:旧版服务查询传递。
    Agent
    serviceTypestring

    服务类型,取值如下:

    • dubbo
    • springCloud
    • hsf
    • istio
    SpringCloud
    searchTypestring

    服务类型,取值如下:

    • app:应用维度查询。
    • service:服务维度查询。
    • providerIp:IP维度查询。
    App
    searchValuestring

    搜索关键字:

    • 如果searchType=app,searchValue填写appId
    • 如果serachType=service,searchValue填写serviceName
    • 如果searchType=providerIp,searchValue填写应用IP地址。
    com.alibaba.edas.HelloService
    sidestring

    提供者侧或者消费者侧,取值如下:

    • provider
    • consumer
    provider
    pageinteger

    列表的页码,从0开始。

    0
    sizeinteger

    分页查询时每页的行数。

    10

    返回参数

    名称类型描述示例值
    object

    数据结构。

    Codeinteger

    接口状态或POP错误码。

    200
    Messagestring

    接口请求返回的信息。

    success
    Successboolean

    调用是否成功。

    true
    Dataobject

    数据。

    TotalPagesinteger

    总页数。

    1
    TotalElementsinteger

    总数据量。

    6
    Sizeinteger

    页大小。

    8
    Contentarray

    组数据。

    object

    数据结构。

    EdasAppNamestring

    应用名。

    k8s-lq-cartservice
    InstanceNuminteger

    实例数量。

    1
    Versionstring

    版本号。

    1.0.0
    ServiceIdstring

    服务ID。

    xx
    EdasAppIdstring

    应用ID。

    efbda488-7b33-432f-****-36530047****
    ServiceNamestring

    服务名。

    com.alibabacloud.hipstershop.CartService
    RegisterTypestring

    注册类型。

    xx
    Groupstring

    分组。

    DUBBO

    示例

    请求示例

    POST /pop/sp/api/mseForOam/getServiceListPage HTTP/1.1
    公共请求头
    

    正常返回示例

    JSON格式

    {
        "Code": 200,
        "Message": "success",
        "Success": true,
        "Data": {
            "TotalPages": 1,
            "TotalElements": 6,
            "Size": 8,
            "Content": {
                "EdasAppName": "k8s-lq-cartservice",
                "InstanceNum": 1,
                "Version": "1.0.0",
                "ServiceId": "xx",
                "EdasAppId": "efbda488-7b33-432f-****-36530047****",
                "ServiceName": "com.alibabacloud.hipstershop.CartService",
                "RegisterType": "xx",
                "Group": "DUBBO"
            }
        }
    }

    XML格式

    <GetServiceListPageResponse>
        <Code>200</Code>
        <Message>success</Message>
        <Success>true</Success>
        <Data>
            <TotalPages>1</TotalPages>
            <TotalElements>6</TotalElements>
            <Size>8</Size>
            <Content>
                <EdasAppName>k8s-lq-cartservice</EdasAppName>
                <InstanceNum>1</InstanceNum>
                <Version>1.0.0</Version>
                <ServiceId>xx</ServiceId>
                <EdasAppId>efbda488-7b33-432f-****-36530047****</EdasAppId>
                <ServiceName>com.alibabacloud.hipstershop.CartService</ServiceName>
                <RegisterType>xx</RegisterType>
                <Group>DUBBO</Group>
            </Content>
        </Data>
    </GetServiceListPageResponse>

    错误码

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

    阿里云首页 企业级分布式应用服务 EDAS 相关技术圈