Help Center/ Cloud Application Engine/ API Reference/ CAE API/ URL Monitoring/ Modifying URL Monitoring Configurations
Updated on 2025-12-19 GMT+08:00

Modifying URL Monitoring Configurations

Function

Modify the URL monitoring configurations.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

PUT /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.

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 is 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.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

api_version

Yes

String

API version. Fixed value: v1.

kind

Yes

String

API type. Fixed value: UrlMonitor.

spec

No

spec object

Table 4 spec

Parameter

Mandatory

Type

Description

log_group_id

No

String

ID of an LTS log group.

This parameter is mandatory when log_status is open and config_type is manual.

log_stream_id

No

String

ID of an LTS log stream.

This parameter is mandatory when log_status is open and config_type is manual.

config_type

No

String

Definition

Log configuration method.

Constraints

This parameter is mandatory when log_status is open.

Range

  • automatic

  • manual

Default Value

N/A.

log_status

Yes

String

Definition

Whether to enable URL monitoring.

Constraints

Mandatory.

Range

  • open

  • close

Default Value

N/A.

Response Parameters

Status code: 200

OK

None

Example Requests

Enable URL monitoring using automatic configurations.

/v1/xxx/cae/url-monitor/configurations

{
  "api_version" : "v1",
  "kind" : "UrlMonitor",
  "spec" : {
    "log_status" : "open",
    "config_type" : "automatic"
  }
}

Example Responses

None

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.