文档首页/ 云应用引擎 CAE/ API参考/ CAE API/ URL监控/ 获取URL监控配置
更新时间：2025-10-22 GMT+08:00
查看PDF
分享

获取URL监控配置

功能介绍

获取URL监控配置。

URI

GET /v1/{project_id}/cae/url-monitor/configurations

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取项目ID请参见获取项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

  • 获取Token，请参考《统一身份认证服务API参考》的“获取用户Token”章节。

    • 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Enterprise-Project-ID

否

String

企业项目ID。

  • 创建环境时，环境会绑定企业项目ID。

  • 最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。

  • 该字段不传（或传为字符串“0”）时，则查询默认企业项目下的资源。

说明：
关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。

X-Environment-ID

是

String

环境ID。

  • 获取环境ID，通过获取环境列表来获取环境信息。

  • 请求响应成功后在响应体的items数组中的一个元素即为一个环境的信息，其中id字段即是环境ID。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

api_version

Array of strings

API版本，固定值“v1”，该值不可修改。

kind

Array of strings

API类型，固定值“Environment”，该值不可修改。

spec

spec object
表4 spec

参数

参数类型

描述

id

String

ID

log_group_id

String

LTS日志组的ID

log_stream_id

String

LTS日志流的ID

log_status

String

URL监控日志状态

open：打开URL监控

close：关闭URL监控

deploy_status

String

URL监控部署状态

  • Created -已创建

  • Deploying - 部署中

  • Running - 运行中

  • Failed - 失败

config_type

String

配置方式

automatic：自动配置

manual：自定义配置

请求示例

无

响应示例

状态码：200

请求成功。

{
  "api_version" : "v1",
  "kind" : "UrlMonitor",
  "spec" : {
    "id" : "d673678d-cfda-4fa3-80ec-70f9f55a2619",
    "log_status" : "open",
    "config_type" : "manual",
    "log_stream_id" : "15c79719-fa38-413e-aa71-112e20e25eb5",
    "log_group_id" : "fcec04c6-fa69-4102-9eb8-c0886aec1d29",
    "deploy_status" : "Running"
  }
}

状态码

状态码

描述

200

请求成功。

错误码

请参见错误码。

父主题： URL监控