全部產品
Search
文件中心

Serverless App Engine:DescribeNamespaceResources - 查詢命名空間內的資源資訊

更新時間:Apr 23, 2026

查詢命名空間內的資源資訊。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

sae:DescribeNamespaceResources

get

*全部資源

*

請求文法

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

請求參數

名稱

類型

必填

描述

樣本值

NamespaceId

string

長版命名空間 ID。如果設定了該參數會繼續生效而忽略 NameSpaceShortId,該參數是為了相容保留,推薦使用短版命名空間 ID,簡化參數。

cn-shanghai:test

NameSpaceShortId

string

短版命名空間 ID,不需要帶上 region,推薦。

test

返回參數

名稱

類型

描述

樣本值

object

返回資料。

RequestId

string

請求 ID。

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

Message

string

附加資訊。取值說明如下:

  • 請求正常,返回 success

  • 請求異常,返回具體異常錯誤碼。

success

TraceId

string

調用鏈 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

使用者識別碼。

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 Agent 的版本號碼。

SlsConfigs

string

日誌採集到 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 上的 Project 名稱。

  • logDir:日誌路徑。

  • logType:日誌類型。stdout 表示容器標準輸出日誌,僅可設定 1 條;如果不設定,則表示收集檔案日誌。

  • logstoreName:配置 SLS 上的 Logstore 名稱。

  • logtailName:配置 SLS 上的 Logtail 名稱,如果不指定,則表示建立 Logtail。

多次部署時如果 SLS 採集配置沒有變更,則不需要設定該參數(即請求中無需包含 SlsConfigs 欄位);如果不再需要使用 SLS 採集功能,您需要在請求中將該欄位的值設定為空白字串(即請求中 SlsConfigs 欄位的值為"")。

ErrorCode

string

錯誤碼。取值說明如下:

  • 請求成功:不返回 ErrorCode 欄位。

  • 請求失敗:返回 ErrorCode 欄位。具體資訊,請參見本文的錯誤碼列表。

Code

string

介面狀態或 POP 錯誤碼。取值說明如下:

  • 2xx:成功。

  • 3xx:重新導向。

  • 4xx:請求錯誤。

  • 5xx:伺服器錯誤。

200

Success

boolean

查詢命名空間資源資訊是否成功。取值說明如下:

  • true:查詢成功。

  • false:查詢失敗。

true

樣本

正常返回樣本

JSON格式

{
  "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 status code

錯誤碼

錯誤資訊

描述

400 InvalidParameter.Obviously The specified parameter is invalid {%s}. 不合法的參數{%s}。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情