DescribeNamespaces API リファレンス - Serverless App Engine (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:DescribeNamespaces

get

*All Resource

*

なし

リクエスト構文

GET /pop/v1/paas/namespaces HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
CurrentPage	integer	必須	現在のページ番号。	1
PageSize	integer	必須	1 ページあたりのエントリ数。有効値：0～10000。	10

レスポンスフィールド

フィールド	型	説明	例
	object	返されるデータ。
RequestId	string	リクエスト ID。	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	システムから返されたメッセージ。リクエストが成功した場合、success が返されます。リクエストが失敗した場合、特定のエラーメッセージが返されます。	success
TraceId	string	呼び出しの詳細をクエリするために使用できるトレース ID。	0a981dd515966966104121683d****
Data	object	名前空間の詳細。
CurrentPage	integer	現在のページ番号。	1
TotalSize	integer	名前空間の総数。	100
PageSize	integer	各ページで返されるエントリ数。	10
Namespaces	array<object>	名前空間のリスト。
	object	名前空間の詳細。
NamespaceDescription	string	名前空間の説明。	desc
AccessKey	string	アプリケーション構成管理 (ACM) のアクセスキー ID。ACM 名前空間のデータを管理するために使用されます。詳細については、「Alibaba Cloud アクセスキーと ACM 固有のアクセスキーの違い」をご参照ください。	b34dbe3315c64f9f99b58ea447ec****
SecretKey	string	ACM のシークレットアクセスキー。ACM 名前空間のデータを管理するために使用されます。詳細については、「Alibaba Cloud アクセスキーと ACM 固有のアクセスキーの違い」をご参照ください。	G/w6sseK7+nb3S6HBmANDBMD****
NamespaceId	string	名前空間 ID。デフォルトの名前空間は、クエリ、変更、または削除できません。	cn-beijing:test
AddressServerHost	string	サービスエンドポイント。	addr-bj-internal.edas.aliyun.com
NamespaceName	string	名前空間の名前。	name
TenantId	string	テナント ID。	838cad95-973f-48fe-830b-2a8546d7****
RegionId	string	リージョン ID。たとえば、「cn-beijing」は中国 (北京) を示します。	cn-beijing
NameSpaceShortId	string	名前空間の短い ID。	test
ErrorCode	string	エラーコード。このパラメーターは、リクエストが失敗した場合にのみ返されます。詳細については、このトピックの「エラーコード」セクションをご参照ください。
Code	string	HTTP ステータスコード。 2xx：リクエストは成功しました。 3xx：リクエストはリダイレクトされました。 4xx：リクエストは無効です。 5xx：サーバー側のエラーが発生しました。	200
Success	boolean	リクエストが成功したかどうかを示します。 true：リクエストは成功しました。 false：リクエストは失敗しました。	true

例

成功レスポンス

JSONJSON

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a981dd515966966104121683d****",
  "Data": {
    "CurrentPage": 1,
    "TotalSize": 100,
    "PageSize": 10,
    "Namespaces": [
      {
        "NamespaceDescription": "desc",
        "AccessKey": "b34dbe3315c64f9f99b58ea447ec****",
        "SecretKey": "G/w6sseK7+nb3S6HBmANDBMD****",
        "NamespaceId": "cn-beijing:test",
        "AddressServerHost": "addr-bj-internal.edas.aliyun.com",
        "NamespaceName": "name",
        "TenantId": "838cad95-973f-48fe-830b-2a8546d7****",
        "RegionId": "cn-beijing",
        "NameSpaceShortId": "test"
      }
    ]
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

エラーコード

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

変更履歴

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