DescribeNamespaceList API で名前空間リストを取得 - 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:DescribeNamespaceList

get

*All Resource

*

なし

リクエスト構文

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

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ContainCustom	boolean	任意	カスタム名前空間を返すかどうかを指定します。有効な値： true：システムはカスタム名前空間を返します。 false：システムはカスタム名前空間を返しません。	true
HybridCloudExclude	boolean	任意	ハイブリッドクラウドの名前空間を除外するかどうかを示します。有効な値： true：ハイブリッドクラウドの名前空間は除外されます。 false：ハイブリッドクラウドの名前空間は含まれます。	true

レスポンスフィールド

フィールド	型	説明	例
	object	返されるデータ。
RequestId	string	リクエスト ID。	30375C38-F4ED-4135-A0AE-5C75DC7F****
Message	string	返されるメッセージ。有効な値： success：呼び出しが成功した場合、success が返されます。エラーコード：呼び出しが失敗した場合、エラーコードが返されます。	success
TraceId	string	リクエストの詳細を照会するために使用されるトレース ID。	ac1a0b2215622920113732501e****
Data	array<object>	名前空間のリスト。
	object	名前空間に関する情報。
VpcId	string	Virtual Private Cloud (VPC) の ID。	vpc-2ze0i263cnn311nvj****
VSwitchId	string	vSwitch の ID。	vsw-2ze559r1z1bpwqxwp****
Custom	boolean	カスタム名前空間が返されるかどうかを示します。有効な値： true：カスタム名前空間が返されます。 false：カスタム名前空間は返されません。	true
AgentInstall	string	エージェントをインストールするために実行されたコマンド。	http://edas-bj.oss-cn-beijing-internal.aliyuncs.com/test/install.sh
NamespaceId	string	名前空間の ID。	cn-beijing:test
HybridCloudEnable	boolean	ハイブリッドクラウドの名前空間を除外するかどうかを示します。有効な値： true：ハイブリッドクラウドの名前空間は除外されます。 false：ハイブリッドクラウドの名前空間は含まれます。	false
SecurityGroupId	string	セキュリティグループの ID。	sg-wz969ngg2e49q5i4****
Current	boolean	このパラメーターは無効になりました。	false
NamespaceName	string	名前空間の名前。	test
RegionId	string	名前空間が属するリージョン。	cn-beijing
NameSpaceShortId	string	名前空間のショート ID。	test
ErrorCode	string	エラーコード。有効な値：呼び出しが成功した場合、ErrorCode パラメーターは返されません。呼び出しが失敗した場合、ErrorCode パラメーターが返されます。詳細については、このトピックの「エラーコード」セクションをご参照ください。
Code	string	HTTP ステータスコード。有効な値： 2xx：呼び出しは成功しました。 3xx：呼び出しはリダイレクトされました。 4xx：呼び出しは失敗しました。 5xx：サーバーエラーが発生しました。	200
Success	boolean	名前空間のリストが照会されたかどうかを示します。有効な値： true：リストは照会されました。 false：リストの照会に失敗しました。	true

例

成功レスポンス

JSONJSON

{
  "RequestId": "30375C38-F4ED-4135-A0AE-5C75DC7F****",
  "Message": "success",
  "TraceId": "ac1a0b2215622920113732501e****",
  "Data": [
    {
      "VpcId": "vpc-2ze0i263cnn311nvj****",
      "VSwitchId": "vsw-2ze559r1z1bpwqxwp****",
      "Custom": true,
      "AgentInstall": "http://edas-bj.oss-cn-beijing-internal.aliyuncs.com/test/install.sh",
      "NamespaceId": "cn-beijing:test",
      "HybridCloudEnable": false,
      "SecurityGroupId": "sg-wz969ngg2e49q5i4****",
      "Current": false,
      "NamespaceName": "test",
      "RegionId": "cn-beijing",
      "NameSpaceShortId": "test"
    }
  ],
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

エラーコード

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

変更履歴

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