すべてのプロダクト
Search
ドキュメントセンター

Platform For AI:DescribeServiceEndpoints

最終更新日:Jan 28, 2026

サービスエンドポイントのリストを取得します。

今すぐお試しください

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

get

*All Resource

*

なし なし

リクエスト構文

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

パスパラメータ

パラメーター

必須 / 任意

説明

ClusterId

string

任意

リージョン ID。

cn-hangzhou

ServiceName

string

必須

サービス名。詳細については、「ListServices」をご参照ください。

service_name

リクエストパラメーター

パラメーター

必須 / 任意

説明

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

レスポンスフィールド

フィールド

説明

object

応答。

RequestId

string

リクエスト ID。

739998B5-FB39-12A3-8323-0FA340317298

Message

string

返されたメッセージ。

执行成功。

AccessToken

string

サービストークン。

Nzc5N2FhN****TQ0YzBmYTIyN2MxZTUxN2NkYjg4MTJmMWQxZmY1****

Endpoints

array<object>

サービスエンドポイントのリスト。

object

EndpointType

string

サービスエンドポイントの接続タイプ。有効な値:

  • DefaultGateway: サービスは共有ゲートウェイを使用して接続されます。

  • PrivateGateway: サービスは専用ゲートウェイを使用して接続されます。

  • Nlb: サービスは Network Load Balancer (NLB) インスタンスにアタッチされます。

  • Nacos: サービスは Nacos インスタンスにアタッチされます。

Nlb

BackendId

string

バックエンドサービスの ID。このパラメーターの値は、EndpointType の値によって異なります。

  • EndpointType が DefaultGateway の場合、このパラメーターは default に設定されます。

  • EndpointType が PrivateGateway の場合、このパラメーターは専用ゲートウェイの ID です。

  • EndpointType が Nlb の場合、このパラメーターは NLB インスタンスの ID です。

  • EndpointType が Nacos の場合、このパラメーターは Nacos インスタンスの ID です。

nlb-5q4sp7u6oorkha****

PathType

string

エンドポイントのタイプ。有効な値:

  • Group: オーディエンスグループのエンドポイント。

  • Service: サービスのエンドポイント。

Service

IntranetEndpoints

array

内部エンドポイントのリスト。

string

内部エンドポイント。

nlb-5q4sp7u6oor****jvv.cn-hangzhou.nlb.aliyuncs.com

InternetEndpoints

array

インターネット向けエンドポイントのリスト。

string

インターネット向けエンドポイント。

null

Port

integer

ポート番号。このパラメーターは、サービスが NLB または Nacos インスタンスにアタッチされている場合にのみ返されます。

9090

成功レスポンス

JSONJSON

{
  "RequestId": "739998B5-FB39-12A3-8323-0FA340317298",
  "Message": "执行成功。",
  "AccessToken": "Nzc5N2FhN****TQ0YzBmYTIyN2MxZTUxN2NkYjg4MTJmMWQxZmY1****",
  "Endpoints": [
    {
      "EndpointType": "Nlb",
      "BackendId": "nlb-5q4sp7u6oorkha****",
      "PathType": "Service",
      "IntranetEndpoints": [
        "nlb-5q4sp7u6oor****jvv.cn-hangzhou.nlb.aliyuncs.com"
      ],
      "InternetEndpoints": [
        "null"
      ],
      "Port": 9090
    }
  ]
}

エラーコード

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

変更履歴

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