ListPrivateAccessApplications - 批量查询内网访问应用

批量查询当前阿里云账号下所有内网访问应用的信息。

调试

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

授权信息

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

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

请求参数

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

分页查询时显示的当前页的页码。取值:1~10000。

1
PageSizeinteger

分页查询时设置的每页数量。取值:1~1000。

10
Namestring

内网访问应用名称。长度为 1~128 个字符,支持中文和大小写英文字母,可包含数字、半角句号(.)、下划线(_)和短划线(-)。

private_access_application_name
Statusstring

内网访问应用状态。取值:

  • Enabled:开启。
  • Disabled:关闭。
Enabled
Addressstring

内网访问应用地址。长度为 1~128 个字符,支持 IPv4 地址、CIDR、域名、泛域名。

192.168.0.0/16
ApplicationIdsarray

内网访问应用 ID 集合。最多可输入 100 个内网访问应用 ID。

string

内网访问应用 ID。取值来源:

pa-application-e12860ef6c48****
TagIdstring

内网访问标签 ID。取值来源:

tag-d3f64e8bdd4a****
PolicyIdstring

内网访问策略 ID。取值来源:

pa-policy-54a7838a48bf****
ConnectorIdstring

ConnectorID。取值来源: ListConnectors 批量查询 Connector。

connector-94db94e06b98****

返回参数

名称类型描述示例值
object
RequestIdstring

本次请求的 ID。

748CFDC7-1EB6-5B8B-9405-DA76ED5BB60D
TotalNuminteger

内网访问应用总数。

1
Applicationsarray<object>

内网访问应用列表。

applicationobject

内网访问应用。

ApplicationIdstring

内网访问应用 ID。

pa-application-e12860ef6c48****
Namestring

内网访问应用名称。

private_access_application_name
Descriptionstring

内网访问应用描述。

这是一条内网访问应用
Addressesarray

内网访问应用地址集合。

addressstring

内网访问应用地址。长度为 1~128 个字符,支持 IPv4 地址、CIDR、域名、泛域名。

192.168.0.0/16
PortRangesarray<object>

内网访问应用端口范围集合。多个端口范围不可重复或重叠。

portRangeobject

内网访问应用端口范围。取值:1~65535。

Begininteger

起始端口。

80
Endinteger

结束端口。

81
Protocolstring

内网访问应用协议。取值:

  • All:全部。
  • TCP
  • UDP
All
Statusstring

内网访问应用状态。取值:

  • Enabled:开启。
  • Disabled:关闭。
Enabled
CreateTimestring

内网访问应用创建时间。

2022-12-16 15:03:42
TagIdsarray

内网访问标签 ID 集合。

tagIdstring

内网访问标签 ID。

tag-d3f64e8bdd4a****
PolicyIdsarray

内网访问策略 ID 集合。

policyIdstring

内网访问策略 ID。

pa-policy-54a7838a48bf****
ConnectorIdsarray

ConnectorID 集合。

connectorIdstring

ConnectorID。

connector-94db94e06b98****

示例

正常返回示例

JSON格式

{
  "RequestId": "748CFDC7-1EB6-5B8B-9405-DA76ED5BB60D",
  "TotalNum": 1,
  "Applications": [
    {
      "ApplicationId": "pa-application-e12860ef6c48****",
      "Name": "private_access_application_name",
      "Description": "这是一条内网访问应用",
      "Addresses": [
        "192.168.0.0/16"
      ],
      "PortRanges": [
        {
          "Begin": 80,
          "End": 81
        }
      ],
      "Protocol": "All",
      "Status": "Enabled",
      "CreateTime": "2022-12-16 15:03:42",
      "TagIds": [
        "tag-d3f64e8bdd4a****"
      ],
      "PolicyIds": [
        "pa-policy-54a7838a48bf****"
      ],
      "ConnectorIds": [
        "connector-94db94e06b98****"
      ],
      "BrowserAccessStatus": "",
      "L7ProxyDomainAutomatic": "",
      "L7ProxyDomainCustom": ""
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-09-11OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
2023-08-30OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
2023-04-12API 内部配置变更,不影响调用查看变更详情