ListKyuubiServices API でワークスペース内の全 Kyuubi ゲートウェイをクエリ - E-MapReduce

Kyuubi ゲートウェイをリストします。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

emr-serverless-spark:ListKyuubiServices

none

*All Resource

*

なし

リクエスト構文

GET /api/v1/kyuubi/{workspaceId} HTTP/1.1

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
workspaceId	string	任意	ワークスペース ID。	w-d2d82aa09155****

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

リクエストパラメーターは必要ありません。

レスポンスフィールド

フィールド	型	説明	例
	object	応答本文。
requestId	string	リクエスト ID。	DD6B1B2A-5837-5237-ABE4-FF0C8944****
data	object	返されたデータ。
kyuubiServices	array<object>	Kyuubi サーバーのリスト。
	object	Kyuubi サーバーのレコード。
kyuubiConfigs	string	Kyuubi サーバーの構成。	kyuubi.conf.key=value1 kyuubi.conf.key1=value2
sparkConfigs	string	Kyuubi サーバーによって起動された Spark アプリケーションのデフォルト構成。	spark.conf.key=value1 spark.conf.key1=value2
state	string	Kyuubi サーバーのステータス。	Running
name	string	Kyuubi サーバーの名前。	test
queue	string	キュー名。	dev_queue
createTime	string	サーバーが作成された時間。	2025-03-11T08:21:58Z
startTime	string	Kyuubi サーバーが最後に起動された時間。	2024-11-23 09:22:00
creator	string	サーバーを作成したユーザーの UID。	103*******
kyuubiServiceId	string	Kyuubi サーバー ID。	kb-070104e7631242448d12a1377c309f30
innerEndpoint	string	内部エンドポイント。	kyuubi-cn-hangzhou-internal.spark.emr.aliyuncs.com
publicEndpoint	string	パブリックエンドポイント。	emr-spark-kyuubi-gateway-cn-hangzhou.aliyuncs.com
releaseVersion	string	Spark エンジンのバージョン番号。	esr-4.2.0 (Spark 3.5.2, Scala 2.12)
computeInstance	string	Kyuubi サーバーのインスタンスタイプ。	4C16G
replica	integer	Kyuubi サーバーのレプリカ数。	3
kyuubiReleaseVersion	string	Kyuubi サーバーのバージョン。	1.9.2-0.0.1

例

成功レスポンス

JSONJSON

{
  "requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****",
  "data": {
    "kyuubiServices": [
      {
        "kyuubiConfigs": "kyuubi.conf.key=value1\nkyuubi.conf.key1=value2",
        "sparkConfigs": "spark.conf.key=value1\nspark.conf.key1=value2",
        "state": "Running",
        "name": "test",
        "queue": "dev_queue",
        "createTime": "2025-03-11T08:21:58Z",
        "startTime": "2024-11-23 09:22:00",
        "creator": "103*******",
        "kyuubiServiceId": "kb-070104e7631242448d12a1377c309f30",
        "innerEndpoint": "kyuubi-cn-hangzhou-internal.spark.emr.aliyuncs.com",
        "publicEndpoint": "emr-spark-kyuubi-gateway-cn-hangzhou.aliyuncs.com",
        "releaseVersion": "esr-4.2.0 (Spark 3.5.2, Scala 2.12)\n",
        "computeInstance": "4C16G",
        "replica": 3,
        "kyuubiReleaseVersion": "1.9.2-0.0.1"
      }
    ]
  }
}

エラーコード

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

変更履歴

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