すべてのプロダクト
Search

このプロダクト

    Serverless App Engine:DescribeNamespace

    ドキュメントセンター

    Serverless App Engine:DescribeNamespace

    最終更新日:Apr 22, 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    sae:DescribeNamespace

    get

    *All Resource

    *

    		 なし なし

    リクエスト構文

    GET /pop/v1/paas/namespace HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    NamespaceId

    string

    任意

    名前空間の ID。デフォルトの名前空間に関する情報は照会も変更もできません。デフォルトの名前空間は削除できません。

    cn-beijing:test
    NameSpaceShortId

    string

    任意

    名前空間のショート ID。リージョン ID を指定する必要はありません。このパラメーターの値は、最大 20 文字で、小文字と数字のみを含めることができます。

    test

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスパラメーター。

    RequestId

    string

    リクエスト ID。

    91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
    Message

    string

    返される追加情報。有効な値：

    • success：呼び出しが成功した場合、success が返されます。

    • エラーコード：呼び出しが失敗した場合、エラーコードが返されます。

    success
    TraceId

    string

    リクエストの詳細を照会するために使用されるトレース ID。

    0a981dd515966966104121683d****
    Data

    object

    名前空間に関する情報。

    NamespaceDescription

    string

    名前空間の説明。

    desc
    NamespaceId

    string

    名前空間の ID。デフォルトの名前空間に関する情報は照会も変更もできません。デフォルトの名前空間は削除できません。

    cn-beijing:test
    NamespaceName

    string

    名前空間の名前。

    name
    RegionId

    string

    リージョン ID。

    cn-beijing
    NameSpaceShortId

    string

    名前空間のショート ID。

    test
    EnableMicroRegistration

    boolean

    SAE 組み込みレジストリが有効になっているかどうかを示します。有効な値：

    • true

    • false

    true
    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": "0a981dd515966966104121683d****",
  "Data": {
    "NamespaceDescription": "desc",
    "NamespaceId": "cn-beijing:test",
    "NamespaceName": "name",
    "RegionId": "cn-beijing",
    "NameSpaceShortId": "test",
    "EnableMicroRegistration": true
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

    エラーコード

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

    変更履歴

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