全部产品
Search

搜索本产品

    人工智能平台 PAI：ListServiceInstances - 查询服务实例列表

    文档中心

    人工智能平台 PAI：ListServiceInstances - 查询服务实例列表

    更新时间：Nov 21, 2024

    获取指定服务的实例列表。

    调试

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

    授权信息

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

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

    请求语法

    GET /api/v2/services/{ClusterId}/{ServiceName}/instances HTTP/1.1

    请求参数

    名称类型必填描述示例值
    ClusterIdstring是

    服务所在地域 ID。

    		cn-shanghai
    ServiceNamestring是

    服务名称。如何获取服务名称，请参见ListServices 。

    		foo
    PageNumberinteger否

    服务实例列表的页，默认值为 1。

    		1
    PageSizeinteger否

    分页查询时设置的每页显示的实例数量，默认为 100。

    		20
    Filterstring否

    关键字搜索。支持按实例名、实例 IP、实例所在的机器的 IP、实例规格搜索。

    		10.118.xx.xx
    ResourceTypestring否

    服务实例所在的资源组类型。

    枚举值：
    • PublicResource：公共资源组。
    • DedicatedResource：专属资源组。
    		PublicResource
    InstanceTypestring否

    实例规格。

    		ecs.c7.large
    InstanceStatusstring否

    服务实例的状态。

    		Running
    InstanceIPstring否

    服务实例的 IP。

    		10.224.xx.xx
    InstanceNamestring否

    服务实例的名字。

    		foo-bdc5xxxx-8l7rk
    HostIPstring否

    服务实例所在机器的 IP。

    		10.224.xx.xx
    IsSpotboolean否

    是否为抢占式实例。

    		false
    Rolestring否

    服务的角色。

    枚举值：
    • DataSet：数据集服务。
    • SDProxy：Stable-Diffusion代理服务。
    • Standard：普通预测服务。
    • Queue：队列服务。
    		Queue
    Sortstring否

    排序字段。

    枚举值：
    • StartTime：创建时间。
    		StartTime
    Orderstring否

    排序顺序。

    枚举值：
    • asc：升序。
    • desc：降序。
    		desc

    返回参数

    名称类型描述示例值
    object

    返回结果。

    RequestIdstring

    请求 ID。

    		40325405-579C-4D82****
    Instancesarray

    服务实例列表。

    Instance

    服务实例。

    PageNumberinteger

    返回查询的实例列表的当前页码。

    		1
    PageSizeinteger

    返回每页显示的实例数量。

    		20
    TotalCountinteger

    实例总数。

    		1

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "40325405-579C-4D82****",
  "Instances": [
    {
      "HostIP": "11.0.XX.XX",
      "HostName": "smart-scene-cls-854dbdc99d-****",
      "InnerIP": "172.17.0.17",
      "InstanceName": "foo-5fc8946767-v****",
      "InstancePort": 8080,
      "LastState": [
        []
      ],
      "Namespace": "foo",
      "Reason": "RUNNING",
      "RestartCount": 1,
      "Status": "Running",
      "TotalProcesses": 1,
      "ReadyProcesses": 1,
      "StartAt": "2021-05-27T09:46:05Z",
      "Role": "Standard",
      "ResourceType": "PublicResource",
      "TenantInstanceIP": "192.168.xx.xx",
      "TenantHostIP": "192.168.xx.xx",
      "IsSpot": false,
      "CurrentAmount": 0.444,
      "OriginalAmount": 2.2,
      "Isolated": false,
      "Zone": "cn-shanghai-a",
      "ExternalIP": "192.168.1.100",
      "ExternalInstancePort": 8080,
      "StartTime": "2021-05-27T09:46:05Z"
    }
  ],
  "PageNumber": 1,
  "PageSize": 20,
  "TotalCount": 1
}

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2023-05-06OpenAPI 入参发生变更查看变更详情