DescribeNamespaceResources で名前空間リソースをクエリ - 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:DescribeNamespaceResources

get

*All Resource

*

なし

リクエスト構文

GET /pop/v1/sam/namespace/describeNamespaceResources HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
NamespaceId	string	任意	名前空間の ID。フォーマットは `リージョン ID:名前空間名` です。このパラメーターは下位互換性のために保持されています。このパラメーターを指定すると、`NameSpaceShortId` は無視されます。リクエストを簡略化するために、`NameSpaceShortId` の使用を推奨します。	cn-shanghai:test
NameSpaceShortId	string	任意	名前空間の ID。リージョン ID は含まれません。このパラメーターの使用を推奨します。	test

レスポンスフィールド

フィールド	型	説明	例
	object	返されるデータ。
RequestId	string	リクエスト ID。	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	返されるメッセージ。有効値：リクエストが成功した場合、success が返されます。リクエストが失敗した場合、エラーコードが返されます。	success
TraceId	string	トレース ID。この ID を使用して、呼び出しの詳細をクエリできます。	0a98a02315955564772843261e****
Data	object	応答データ。
VpcId	string	VPC ID。	vpc-2ze0i263cnn311nvj****
LastChangeOrderId	string	リリース注文 ID。	afedb3c4-63f8-4a3d-aaa3-2c30363f****
BelongRegion	string	名前空間が属するリージョン。	cn-shanghai
NamespaceId	string	名前空間 ID。	cn-shangha:test
SecurityGroupId	string	セキュリティグループ ID。	sg-wz969ngg2e49q5i4****
UserId	string	ユーザー ID。	test@aliyun.com
NamespaceName	string	名前空間名。	test
LastChangeOrderStatus	string	最後のリリース注文のステータス。有効値： READY：リリース注文は準備完了です。 RUNNING：リリース注文は実行中です。 SUCCESS：リリース注文は成功しました。 FAIL：リリース注文は失敗しました。 ABORT：リリース注文は中止されました。 WAIT_BATCH_CONFIRM：リリース注文は手動でのバッチ確認を待機しています。 AUTO_BATCH_WAIT：リリース注文は自動バッチ待機状態です。 SYSTEM_FAIL：システムエラーが発生しました。 WAIT_APPROVAL：リリース注文は承認待ちです。 APPROVED：リリース注文は承認され、実行を待機しています。	SUCCESS
VpcName	string	VPC 名。	test
VSwitchId	string	vSwitch ID。	vsw-2ze559r1z1bpwqxwp****
Description	string	名前空間の説明。	decs
LastChangeOrderRunning	boolean	名前空間でリリース注文が実行中かどうかを示します。有効値： true：リリース注文が実行中です。 false：実行中のリリース注文はありません。	true
AppCount	integer	アプリケーションの数。	1
VSwitchName	string	vSwitch 名。	test
NotificationExpired	boolean	リリース注文の通知が期限切れかどうかを示します。有効値： true：通知は期限切れです。 false：通知は期限切れではありません。	true
TenantId	string	SAE 名前空間のテナント ID。	838cad95-973f-48fe-830b-2a8546d7****
JumpServerAppId	string	ジャンプサーバーアプリケーションの ID。	5ec46468-6b26-4a3c-9f7c-bf88761a****
JumpServerIp	string	ジャンプサーバーの IP アドレス。	120.78.XXX.XX
NameSpaceShortId	string	短縮形式の名前空間 ID。	test
ApmJavaAgentVersion	string	APM Java エージェントのバージョン。
SlsConfigs	string	Simple Log Service (SLS) にログを収集するための構成。 SAE によって自動的に作成される SLS リソースを使用する場合： `[{"logDir":"","logType":"stdout"},{"logDir":"/tmp/a.log"}]`。カスタム SLS リソースを使用する場合： `[{"projectName":"test-sls","logType":"stdout","logDir":"","logstoreName":"sae","logtailName":""},{"projectName":"test","logDir":"/tmp/a.log","logstoreName":"sae","logtailName":""}]`。構成には次のパラメーターが含まれます： projectName：SLS のプロジェクト名。 logDir：ログパス。 logType：ログタイプ。stdout はコンテナの標準出力を示します。stdout エントリは 1 つのみ許可されます。このパラメーターを省略すると、ファイルログが収集されます。 logstoreName：SLS の Logstore 名。 logtailName：SLS の Logtail 名。このパラメーターを省略すると、SAE が Logtail を作成します。後続のデプロイメントで SLS ログ収集構成が変更されない場合、このパラメーターを設定する必要はありません。ログ収集を無効にするには、このパラメーターを空の文字列 ("") に設定します。
ErrorCode	string	エラーコード。このパラメーターは、リクエストが失敗した場合にのみ返されます。詳細については、このトピックのエラーコードセクションをご参照ください。リクエストが成功した場合、ErrorCode フィールドは返されません。リクエストが失敗した場合、ErrorCode フィールドが返されます。詳細については、このトピックのエラーコードのリストをご参照ください。
Code	string	HTTP ステータスコード。有効値： 2xx：リクエストは成功しました。 3xx：リクエストはリダイレクトされました。 4xx：リクエストは無効でした。 5xx：サーバーエラーが発生しました。	200
Success	boolean	名前空間リソースが正常にクエリされたかどうかを示します。 true：クエリは成功しました。 false：クエリは失敗しました。	true

例

成功レスポンス

JSONJSON

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "VpcId": "vpc-2ze0i263cnn311nvj****",
    "LastChangeOrderId": "afedb3c4-63f8-4a3d-aaa3-2c30363f****",
    "BelongRegion": "cn-shanghai",
    "NamespaceId": "cn-shangha:test",
    "SecurityGroupId": "sg-wz969ngg2e49q5i4****",
    "UserId": "test@aliyun.com",
    "NamespaceName": "test",
    "LastChangeOrderStatus": "SUCCESS",
    "VpcName": "test",
    "VSwitchId": "vsw-2ze559r1z1bpwqxwp****",
    "Description": "decs",
    "LastChangeOrderRunning": true,
    "AppCount": 1,
    "VSwitchName": "test",
    "NotificationExpired": true,
    "TenantId": "838cad95-973f-48fe-830b-2a8546d7****",
    "JumpServerAppId": "5ec46468-6b26-4a3c-9f7c-bf88761a****",
    "JumpServerIp": "120.78.XXX.XX",
    "NameSpaceShortId": "test",
    "ApmJavaAgentVersion": "",
    "SlsConfigs": ""
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidParameter.Obviously	The specified parameter is invalid {%s}.

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

変更履歴

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