Help Center/ Cloud Application Engine/ API Reference/ CAE API/ URL Monitoring/ Obtaining URL Monitoring Configurations
Updated on 2025-10-22 GMT+08:00

Obtaining URL Monitoring Configurations

Function

Obtain URL monitoring configurations.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. See Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

  • Obtain the token. For details, see "Obtaining a User Token" in Identity and Access Management API Reference (https://support.huaweicloud.com/intl/en-us/api-iam/iam_30_0001.html).

  • The value of X-Subject-Token in the response header is the token value.

X-Enterprise-Project-ID

No

String

Enterprise project ID.

  • When an environment is created, it will be bound with an enterprise project ID.

  • Enter 0 or up to 36 characters in UUID format with hyphens (-).

  • If this parameter is not specified or set to 0, resources in the default enterprise project are queried.

NOTE:
For details about how to obtain enterprise project IDs and enterprise project features, see Enterprise Management User Guide.

X-Environment-ID

Yes

String

Environment ID.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

api_version

Array of strings

API version. Fixed value: v1.

kind

Array of strings

API type. Fixed value: Environment.

spec

spec object

Table 4 spec

Parameter

Type

Description

id

String

ID

log_group_id

String

ID of an LTS log group.

log_stream_id

String

ID of an LTS log stream.

log_status

String

URL monitoring log status.

open

close

deploy_status

String

URL monitoring deployment status.

  • Created

  • Deploying

  • Running

  • Failed

config_type

String

Configuration method.

automatic

manual

Example Requests

None

Example Responses

Status code: 200

OK

{
  "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"
  }
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.