GetPrivateAccessApplication - 查询内网访问应用详情

更新时间:
复制为 MD 格式

查询当前阿里云账号下内网访问应用详情。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

csas:GetPrivateAccessApplication

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

ApplicationId

string

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

pa-application-e12860ef6c48****

返回参数

名称

类型

描述

示例值

object

RequestId

string

本次请求的 ID。

3ACC5EDC-2B7D-5032-8C58-D7615D66C1D4

Application

object

内网访问应用。

ApplicationId

string

内网访问应用 ID。

pa-application-e12860ef6c48****

Name

string

内网访问应用名称。

private_access_application_name

Description

string

内网访问应用描述。

这是一条内网访问应用

Addresses

array

内网访问应用地址集合。

string

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

192.168.0.0/16

PortRanges

array<object>

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

object

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

Begin

integer

起始端口。

80

End

integer

结束端口。

81

Protocol

string

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

  • All:全部。

  • TCP

  • UDP

枚举值:

  • All :

    All

  • TCP :

    TCP

  • UDP :

    UDP

All

Status

string

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

  • Enabled:开启。

  • Disabled:关闭。

枚举值:

  • Enabled :

    开启

  • Disabled :

    关闭

Enabled

CreateTime

string

内网访问应用创建时间。

2022-08-30 16:50:32

TagIds

array

内网访问标签 ID 集合。

string

内网访问标签 ID。

tag-d3f64e8bdd4a****

PolicyIds

array

内网访问策略 ID 集合。

string

内网访问策略 ID。

pa-policy-54a7838a48bf****

ConnectorIds

array

ConnectorID 集合。

string

ConnectorID。

connector-94db94e06b98****

BrowserAccessStatus

string

浏览器访问模式。取值:

  • Enabled:开启。

  • Disabled:关闭。

Enabled

L7ProxyDomainAutomatic

string

浏览器访问模式参数:映射代理域名。

app.example.com

L7ProxyDomainCustom

string

浏览器访问模式参数:自定义代理域名。

app.example.com

L7Config PAL7Config

浏览器访问模式参数:应用配置。

AutoGenerated

integer

是否云应用自动生成。

false

ConfigMode

string

配置模式,枚举值:

  • 空字符串:默认模式。

  • Precise:精细模式。

Precise

AddressGroups

array

应用地址组。在 ConfigMode 为 Precise 时必传;在 ConfigMode 为空字符串时不可传。

AddressGroup

应用地址组。在 ConfigMode 为 Precise 时必传;在 ConfigMode 为空字符串时不可传。

示例

正常返回示例

JSON格式

{
  "RequestId": "3ACC5EDC-2B7D-5032-8C58-D7615D66C1D4",
  "Application": {
    "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-08-30 16:50:32",
    "TagIds": [
      "tag-d3f64e8bdd4a****"
    ],
    "PolicyIds": [
      "pa-policy-54a7838a48bf****"
    ],
    "ConnectorIds": [
      "connector-94db94e06b98****"
    ],
    "BrowserAccessStatus": "Enabled",
    "L7ProxyDomainAutomatic": "app.example.com",
    "L7ProxyDomainCustom": "app.example.com",
    "L7Config": {
      "RequestQueryRewriteConfig": {
        "Ops": [
          {
            "Op": "add",
            "OldValue": "old_value",
            "Value": "new_value",
            "Key": "X-Test-Param",
            "ValueVariable": "sase_app_name"
          }
        ]
      },
      "JsHookConfig": {
        "Mode": "disabled",
        "ReplaceRules": [
          {
            "From": "before",
            "To": "after"
          }
        ]
      },
      "BypassConfig": {
        "AppBypassFroms": [
          "10.x.x.1/24\n"
        ],
        "Mode": "disabled",
        "UrlBypassRules": [
          {
            "Paths": [
              "/api/xxx"
            ],
            "Froms": [
              "10.x.x.1/24\n"
            ]
          }
        ]
      },
      "CertId": "cert-xxxx",
      "ResponseHeaderRewriteConfig": {
        "Ops": [
          {
            "Op": "add",
            "OldValue": "old_value",
            "Value": "new_value",
            "Key": "X-Test-Param",
            "ValueVariable": "sase_app_name"
          }
        ]
      },
      "ResponseRewriteConfig": {
        "Mode": "auto",
        "ReplaceRules": [
          {
            "From": "before",
            "To": "after"
          }
        ]
      },
      "RequestHeaderRewriteConfig": {
        "Ops": [
          {
            "Op": "add",
            "OldValue": "old_value",
            "Value": "new_value",
            "Key": "X-Test-Param",
            "ValueVariable": "sase_app_name"
          }
        ]
      },
      "DnsConfig": {
        "DnsServers": [
          "10.x.x.1"
        ]
      },
      "ProxyDomainTypes": "automatic"
    },
    "AutoGenerated": 0,
    "ConfigMode": "Precise",
    "AddressGroups": [
      {
        "Addresses": [
          ""
        ],
        "Ports": [
          {
            "Begin": 0,
            "End": 0
          }
        ]
      }
    ]
  }
}

错误码

HTTP status code

错误码

错误信息

描述

404 Application.NotFound The application is not found. 指定的应用不存在。

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

变更历史

更多信息,参考变更详情