文档

GetRetcodeAppByPid - 根据Pid获取前端监控应用

更新时间:

根据前端监控应用Pid返回前端监控应用对象。

调试

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

授权信息

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

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

请求参数

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

应用 PID。在 ARMS 控制台的前端监控>前端列表页面单击目标应用名称。此时浏览器地址栏中的 URL 即包含应用的 pid,格式为 pid=xxx。由于浏览器进行了编码,因此需要对 pid 稍作修改。例如,如果 URL 中包含的 pid 为 xxx%4074xxx,则需要将%40 替换为@,即:xxx@74xxx。

b590lhguqs@9781be0f44dXXXX
RegionIdstring

地域 ID。

cn-hangzhou
Tagsarray<object>

标签键值对,当您未输入 ResourceIds 参数时必填。取值说明如下: key:标签键,字符长度范围[1,128]。 value:标签值,字符长度范围[1,128]。 区分大小写。如果指定多个标签,则会为指定资源同时创建并绑定多个标签。同一个资源上的同一个标签键只能对应一个标签值。如果您尝试添加已有标签键,则对应的标签值会更新为新值。不能以 aliyun 和 acs:开头,不能包含 http://或者 https://。

object
Keystring

标签键。必填参数,不允许为空字符串。最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://https://

TestKey
Valuestring

标签值。非必填,可以为空字符串。最多支持 128 个字符,不能以acs:开头,不能包含http://或者https://

TestValue

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

2983BEF7-4A0D-47A2-94A2-8E9C5E63****
RetcodeAppobject

前端监控应用返回数据。

AppNamestring

前端监控应用名称。

testRetcodeAppXXXX
RetcodeAppTypestring

前端监控应用类型,包括:

  • web:Web 页面
  • weex:Weex 页面
  • mini_dd:钉钉小程序
  • mini_alipay:支付宝小程序
  • mini_wx:微信小程序
  • mini_common:其他小程序
web
AppIdstring

应用 ID,数据库自增字段。

2787XXXX
Pidstring

应用 ID。

b590lhguqs@9781be0f44dXXXX
ResourceGroupIdstring

资源组 ID,您可以通过资源管理控制台获取。

rg-acfmxidtzXXXX
Tagsarray<object>

标签。

object
Keystring

标签的键(key)。

testKey
Valuestring

标签的值(value)。

testValue

示例

正常返回示例

JSON格式

{
  "RequestId": "2983BEF7-4A0D-47A2-94A2-8E9C5E63****",
  "RetcodeApp": {
    "AppName": "testRetcodeAppXXXX",
    "RetcodeAppType": "web",
    "AppId": "2787XXXX",
    "Pid": "b590lhguqs@9781be0f44dXXXX",
    "ResourceGroupId": "rg-acfmxidtzXXXX",
    "Tags": [
      {
        "Key": "testKey",
        "Value": "testValue"
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-06-19API 内部配置变更,不影响调用查看变更详情
2023-06-28OpenAPI 入参发生变更查看变更详情