DescribeAppServiceDetail でアプリサービス詳細を取得 - SAE - Alibaba Cloud - Serverless App Engine

アプリケーションサービスのメタデータの詳細を説明します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

sae:DescribeAppServiceDetail

list

*All Resource

*

なし

リクエスト構文

GET /pop/v1/sam/service/describeAppServiceDetail HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
AppId	string	必須	アプリケーション ID。	6dcc8c9e-d3da-478a-a066-86dcf820****
ServiceType	string	任意	サービスタイプ。有効な値： dubbo springCloud	springCloud
ServiceGroup	string	任意	サービスグループ。これはカスタムパラメーターです。	springCloud
ServiceVersion	string	任意	サービスバージョン。これはカスタムパラメーターです。	1.0.0
ServiceName	string	任意	サービス名。	edas.service.provider
NacosInstanceId	string	任意	MSE Nacos インスタンスの ID。	mse-cn-sco3r0u****
NacosNamespaceId	string	任意	MSE Nacos 名前空間の ID。	public

レスポンスフィールド

フィールド	型	説明	例
	object	返されるデータ。
RequestId	string	リクエスト ID。	B2C7874F-F109-5B34-8618-2C10BBA2****
Message	string	返される追加情報。	success
TraceId	string	コールチェーン ID。この ID を使用して、呼び出し詳細の完全一致検索を実行します。	0b16399316402420740034918e****
Data	object	返されるデータ。
Group	string	サービスグループ。これはカスタムパラメーターです。	springCloud
ServiceName	string	サービス名。	service-provider
Version	string	サービスバージョン。これはカスタムパラメーターです。	1.0.0
ServiceType	string	サービスタイプ。有効な値： dubbo springCloud	springCloud
ServiceProtocol	string	サービスで使用されるプロトコル。	HTTP
ServicePorts	array	サービスで使用されるポート。
	integer	ポート番号。	8000
ServiceTags	array	サービスタグ。
	string	サービスタグ。	tag1
EdasAppName	string	アプリケーション名。	cn-zhangjiakou-micro-service-******
Metadata	object	メタデータ。例： `{side: "provider", port: "18081", preserved: {register: {source: "SPRING_CLOUD"}},…}`	{side: "provider", port: "18081", preserved: {register: {source: "SPRING_CLOUD"}},…}
SpringApplicationName	string	Spring Cloud アプリケーションの名前。	service-provider
DubboApplicationName	string	Dubbo アプリケーションの名前。	service-consumer
Methods	array<object>	メソッドのリスト。
	array<object>	メソッドのリスト。
MethodController	string	メソッドが属するクラス。	com.serverless.sae.controller.EchoController
ReturnType	string	戻り値のタイプ。	java.lang.String
ReturnDetails	string	返されるデータの詳細。	test
Name	string	メソッド名。	echo
NameDetail	string	メソッドの詳細。	description
ParameterDetails	array	パラメーターの詳細。
	string	パラメーターの詳細。	description
RequestMethods	array	リクエストメソッド。
	string	リクエストメソッド。有効な値： GET ALL	ALL
ParameterTypes	array	パラメータータイプ。
	string	パラメータータイプ。	["java.lang.String"]
Paths	array	リクエストパス。
	string	リクエストパス。形式は次のとおりです： `/path`	["/echo/{str}"]
ParameterDefinitions	array<object>	パラメーター定義。
	object	パラメーター定義。
Type	string	パラメータータイプ。	java.lang.String
Description	string	パラメーターの説明。	description
Name	string	パラメーター名。	arg0
ErrorCode	string	エラーコード。リクエストが成功した場合、ErrorCode フィールドは返されません。リクエストが失敗した場合、ErrorCode フィールドが返されます。詳細については、このトピックのエラーコードのリストをご参照ください。
Code	string	API 呼び出しのステータスまたは POP エラーコード。有効な値： 2xx：成功。 3xx：リダイレクト。 4xx：クライアントエラー。 5xx：サーバーエラー。	200
Success	boolean	メタデータが取得されたかどうかを示します。有効な値： true：メタデータは取得されました。 false：メタデータの取得に失敗しました。	true

例

成功レスポンス

JSONJSON

{
  "RequestId": "B2C7874F-F109-5B34-8618-2C10BBA2****",
  "Message": "success",
  "TraceId": "0b16399316402420740034918e****",
  "Data": {
    "Group": "springCloud",
    "ServiceName": "service-provider",
    "Version": "1.0.0",
    "ServiceType": "springCloud",
    "ServiceProtocol": "HTTP",
    "ServicePorts": [
      8000
    ],
    "ServiceTags": [
      "tag1"
    ],
    "EdasAppName": "cn-zhangjiakou-micro-service-******",
    "Metadata": {
      "test": "test",
      "test2": 1
    },
    "SpringApplicationName": "service-provider",
    "DubboApplicationName": "service-consumer",
    "Methods": [
      {
        "MethodController": "com.serverless.sae.controller.EchoController",
        "ReturnType": "java.lang.String",
        "ReturnDetails": "test",
        "Name": "echo",
        "NameDetail": "description",
        "ParameterDetails": [
          "description"
        ],
        "RequestMethods": [
          "ALL"
        ],
        "ParameterTypes": [
          "[\"java.lang.String\"]"
        ],
        "Paths": [
          "[\"/echo/{str}\"]"
        ],
        "ParameterDefinitions": [
          {
            "Type": "java.lang.String",
            "Description": "description",
            "Name": "arg0"
          }
        ]
      }
    ]
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	Micro.Service.MetaData.NotFound	The micro service metadata not found {%s}.
400	InvalidParameter.Obviously	The specified parameter is invalid {%s}.

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

変更履歴

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