ListServices API によるサービスの一覧 - PAI

サービスの一覧を取得します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

eas:ListServices

get

*Service

acs:eas:{#regionId}:{#accountId}:service/*

なし

リクエスト構文

GET /api/v2/services HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Sort	string	任意	ソート対象のフィールドです。デフォルトでは、タイムスタンプで降順に並べ替えられます。	CreateTime
Order	string	任意	並べ替え順序です。有効な値は以下のとおりです。 desc（デフォルト）：降順 asc：昇順	asc
Filter	string	任意	あいまい検索用のフィルターです。サービス名のみによるあいまい検索が可能です。	foo
PageNumber	integer	任意	サービス一覧のページ番号です。デフォルト値は 1 です。	1
PageSize	integer	任意	ページングクエリにおける 1 ページあたりのサービス数です。デフォルト値は 100 です。	100
GroupName	string	任意	サービスグループの名称です。詳細については、「ListServices」をご参照ください。	foo
ParentServiceUid	string	任意	オーディエンスグループ内のメンバーサービスが属するプライマリサービスの ID です。	eas-m-ijafy3c8cxxxx
ServiceType	string	任意	サービスの種類です。有効な値は以下のとおりです。 Async Standard Queue LLM RAG Serverless LLMGatewayService Offline Task SDCluster ScalableJob ScalableJobService AssistantJob 列挙値: Async : 非同期サービス Standard : 標準デプロイメント OfflineTask : オフラインタスク Proxima : Proxima	Standard
Label	object	任意	ラベルによるフィルター処理を行います。
	string	任意	ラベルを `{"key":"value"}` の形式で指定します。値には null または空文字列を指定できます。この場合、キーのみによるフィルター処理が行われます。	{"key1":"value1","key2":null}
ServiceStatus	string	任意	サービスの実行ステータスです。列挙値: Creating : 作成 Stopped : 停止済み Failed : 失敗 Complete : 完了 Cloning : クローン作成 Stopping : 停止中 Updating : 更新中 Waiting : 待機中 HotUpdate : ホットアップデート Committing : コミット Starting : 開始 DeleteFailed : 削除失敗 Running : 実行中 Developing : 開発中 Scaling : スケーリング Deleted : 削除済み Pending : 保留中 Deleting : 削除	Running
ServiceName	string	任意	サービス名です。	echo_test
ServiceUid	string	任意	サービスの UID です。	eas-m-c9iw3yitxxxx
ResourceName `deprecated`	string	任意	サービスが属するリソースグループの名前または ID です。	eas-r-hd0qwy8cxxxx
WorkspaceId	string	任意	ワークスペースの ID です。	1234**
QuotaId	string	任意	クォータの ID です。	quota1****
Gateway	string	任意	プライベートゲートウェイの ID です。	gw-1uhcqmsc7x22******
Role	string	任意	サービスロール。列挙値: DataLoader : DataLoader FrontEnd : FrontEnd DataSet : DataSet SDProxy : SDProxy LLMScheduler : LLMScheduler ScalableJob : ScalableJob LLMGateway : LLMGateway Job : Job Queue : Queue	LLMGateway
ResourceType	string	任意	サービスが使用するリソースの種類です。有効な値は以下のとおりです。 PublicResource DedicatedResource Lingjun SelfManagedLingjun 列挙値: Lingjun : Lingjun リソースクォータ PublicResource : パブリックリソースグループ DedicatedResource : 専用リソースグループ SelfManagedLingjun : セルフマネージド Lingjun リソースグループ	PublicResource
IncludeNoWorkspace	boolean	任意	ワークスペースに属さないサービスを含めるかどうかを指定します。デフォルト値は true です。	true
ResourceAliasName	string	任意	リソースグループのカスタム名です。	example
ResourceId	string	任意	リソースグループの ID です。詳細については、「ListResources」をご参照ください。	eas-r-asdas****
ResourceBurstable	boolean	任意	サービスのバースト可能なリソースプールを有効にするかどうかを指定します。列挙値: true : true false : false	true
CronscalerEnabled	boolean	任意	サービスに対してスケジュールされた自動スケーリングを有効化するかどうかを指定します。列挙値: true : true false : false	true
AutoscalerEnabled	boolean	任意	サービスに対して Auto Scaling を有効化するかどうかを指定します。列挙値: true : true false : false	true
TrafficState	string	任意	サービスがグループからのトラフィックを受け付けるかどうかを指定します。このパラメーターは、サービスグループ内のサービスにのみ適用されます。列挙値: standalone : なし grouping : はい	grouping
CallerUid	string	任意	サービスを作成したアカウントの UID です。	19989224166xxxxxxx

レスポンスフィールド

フィールド	型	説明	例
	object	応答です。
RequestId	string	リクエスト ID です。	40325405-579C-4D82****
Services	array	サービスの一覧です。
	Service	サービスインスタンスです。
PageNumber	integer	現在のページのページ番号です。	1
PageSize	integer	1 ページあたりのサービス数です。	100
TotalCount	integer	サービスの合計数です。	2

例

成功レスポンス

JSONJSON

{
  "RequestId": "40325405-579C-4D82****",
  "Services": [
    {
      "ServiceGroup": "my_group",
      "Memory": 1024,
      "Cpu": 1,
      "Image": "registry.cn-shanghai.aliyuncs.com/eas/echo_cn-shanghai:v0.0.1-20210129111320",
      "Gpu": 0,
      "TotalInstance": 1,
      "AccessToken": "MzJiMDI5MDliODc0MTlkYmI0ZDhlYmExYjczYTIyZTE3Zm********",
      "ResourceBurstable": true,
      "InternetEndpoint": "http://10123*****.cn-shanghai.aliyuncs.com/api/predict/echo",
      "ResourceAlias": "my_resource",
      "Status": "Running",
      "TrafficState": "standalone",
      "RequestId": "40325405-579C-4D82********",
      "Resource": "eas-r-xxxxxxx",
      "SecondaryInternetEndpoint": "http://10123*****.cn-shanghai.aliyuncs.com/api/predict/async_path.echo\n",
      "Labels": [
        {
          "LabelValue": "value1",
          "LabelKey": "key1"
        }
      ],
      "Namespace": "echo",
      "Weight": 100,
      "Role": "Queue",
      "SecondaryIntranetEndpoint": "http://10123*****.vpc.cn-shanghai.aliyuncs.com/api/predict/async_path.echo\n",
      "PendingInstance": 0,
      "ServiceName": "echo",
      "SafetyLock": "dangerous",
      "Region": "cn-shanghai",
      "AppType": "LLM",
      "InstanceCountInResource": {
        "Quota": 10,
        "Public": 10,
        "Dedicated": 10
      },
      "IntranetEndpoint": "http://10123*****.vpc.cn-shanghai.aliyuncs.com/api/predict/echo",
      "QuotaId": "quotaxxxxx",
      "Message": "Service start successfully",
      "CurrentVersion": 1,
      "RunningInstance": 1,
      "WorkspaceId": "123445",
      "CallerUid": "20123*******",
      "Reason": "RUNNING",
      "Source": "dsw",
      "ServiceId": "eas-m-xxasdat",
      "AppVersion": "v1",
      "CronscalerEnabled": true,
      "ServiceConfig": "{\"metadata\":{\"cpu\":1,\"instance\":1,\"memory\":1024},\"name\":\"echo\",\"processor_entry\":\"libecho.so\",\"processor_path\":\"http://oss-cn-hangzhou-zmf.aliyuncs.com/059247/echo_processor_release.tar.gz\",\"processor_type\":\"cpp\"}",
      "Gateway": "gw-xxxxxx",
      "AppSpecName": "llama_7b_fp16",
      "GPUCorePercentage": 50,
      "GPUMemory": 20,
      "AppConfig": "{\"ModelStorage\":\"oss\"}",
      "CreateTime": "2021-01-29T11:13:20Z",
      "AutoscalerEnabled": true,
      "ExtraData": "{\"blue_green_services\":[\"test\",\"testxxxx\"]}",
      "LatestVersion": 1,
      "UpdateTime": "2021-01-29T11:13:20Z",
      "ServiceUid": "eas-m-xxasdat\n",
      "ParentUid": "11234*******",
      "RoleAttrs": "{\"ApproxMaxLength\":null,\"Length\":null,\"MaxPayloadBytes\":null}"
    }
  ],
  "PageNumber": 1,
  "PageSize": 100,
  "TotalCount": 2
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。