廃止予定 ListResourceServices API でリソースグループ内のサービスをクエリ - PAI

説明

この API は廃止されました。一時的にアクセス可能ですが、更新やバグ修正対応は一切行われません。代わりに eas(2021-07-01) - ListServices への移行を推奨します。より強化された機能に加え、サポートも引き続きご利用いただけます。

今すぐお試しください

この 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:ListResourceServices

get

*Resource

acs:eas:{#regionId}:{#accountId}:resource/{#ResourceId}

なし

リクエスト構文

GET /api/v2/resources/{ClusterId}/{ResourceId}/services HTTP/1.1

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
ClusterId	string	必須	リソースグループが属するリージョンの ID。	cn-shanghai
ResourceId	string	必須	リソースグループの ID。リソースグループの ID をクエリする方法の詳細については、「ListResources」をご参照ください。	iot

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
PageNumber	integer	任意	ページ番号。ページは 1 から始まります。デフォルト値：1。	1
PageSize	integer	任意	1 ページあたりのエントリ数。デフォルト値：100。	20

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
RequestId	string	リクエスト ID。	40325405-579C-4D82****
Services	array	サービス。
	Service	サービスの概要情報。
PageNumber	integer	ページ番号。	1
PageSize	integer	1 ページあたりのエントリ数。	20
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": 20,
  "TotalCount": 2
}

エラーコード

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

変更履歴

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