文档

DescribeNamespaceResources - 查询命名空间内的资源信息

更新时间:

查询命名空间内的资源信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
sae:DescribeNamespaceResourcesget
  • 全部资源
    *

请求语法

GET /pop/v1/sam/namespace/describeNamespaceResources

请求参数

名称类型必填描述示例值
NamespaceIdstring

长版命名空间 ID。如果设置了该参数会继续生效而忽略 NameSpaceShortId,该参数是为了兼容保留,推荐使用短版命名空间 ID,简化参数。

cn-shanghai:test
NameSpaceShortIdstring

短版命名空间 ID,不需要带上 region,推荐。

test

返回参数

名称类型描述示例值
object

返回数据。

RequestIdstring

请求 ID。

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

附加信息。取值说明如下:

  • 请求正常,返回 success
  • 请求异常,返回具体异常错误码。
success
TraceIdstring

调用链 ID,用于精确查询调用信息。

0a98a02315955564772843261e****
Dataobject

返回结果。

VpcIdstring

VPC ID。

vpc-2ze0i263cnn311nvj****
LastChangeOrderIdstring

发布单 ID。

afedb3c4-63f8-4a3d-aaa3-2c30363f****
BelongRegionstring

命名空间所属地域。

cn-shanghai
NamespaceIdstring

命名空间 ID。

cn-shangha:test
SecurityGroupIdstring

安全组 ID。

sg-wz969ngg2e49q5i4****
UserIdstring

用户 ID。

test@aliyun.com
NamespaceNamestring

命名空间名称。

test
LastChangeOrderStatusstring

最近一次发布单状态。取值说明如下:

  • READY:最近一次发布单准备就绪。
  • RUNNING:最近一次发布单处于执行中。
  • SUCCESS:最近一次发布单发布成功。
  • FAIL:最近一次发布单发布失败。
  • ABORT:最近一次发布单中止运行。
  • WAIT_BATCH_CONFIRM:最近一次发布单等待手工批量确认。
  • AUTO_BATCH_WAIT:最近一次发布单处于自动批量等待状态。
  • SYSTEM_FAIL:系统故障。
  • WAIT_APPROVAL:最近一次发布单等待审批。
  • APPROVED:最近一次发布单处于审批通过的待执行状态。
SUCCESS
VpcNamestring

VPC 名称。

test
VSwitchIdstring

vSwitch ID。

vsw-2ze559r1z1bpwqxwp****
Descriptionstring

命名空间描述信息。

decs
LastChangeOrderRunningboolean

命名空间是否有发布单运行。取值说明如下:

  • true:有发布单运行。
  • false:没有发布单运行。
true
AppCountlong

应用个数。

1
VSwitchNamestring

vSwitch 名称。

test
NotificationExpiredboolean

发布单通知是否过期。取值说明如下:

  • true:发布单已过期。
  • false:发布单没有过期。
true
TenantIdstring

SAE 命名空间租户 ID。

838cad95-973f-48fe-830b-2a8546d7****
JumpServerAppIdstring

跳板机应用 ID。

5ec46468-6b26-4a3c-9f7c-bf88761a****
JumpServerIpstring

跳板机 IP 地址。

120.78.XXX.XX
NameSpaceShortIdstring

短版命名空间 ID。

test
ErrorCodestring

错误码。取值说明如下:

  • 请求成功:不返回 ErrorCode 字段。
  • 请求失败:返回 ErrorCode 字段。具体信息,请参见本文的错误码列表。
Codestring

接口状态或 POP 错误码。取值说明如下:

  • 2xx:成功。
  • 3xx:重定向。
  • 4xx:请求错误。
  • 5xx:服务器错误。
200
Successboolean

查询命名空间资源信息是否成功。取值说明如下:

  • 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"
  },
  "ErrorCode": "空",
  "Code": "200",
  "Success": true
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameter.ObviouslyThe specified parameter is invalid {%s}.不合法的参数{%s}。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史