Updated on 2025-11-27 GMT+08:00

Querying Blocked URLs

Function

This API is used to query blocked URLs. To use this API, submit a service ticket.

  • A single tenant can call this API 30 times per second.

Calling Method

For details, see Calling APIs.

URI

GET /v1.0/cdn/content/ban-urls

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

start_time

No

Long

Query start timestamp, in milliseconds.

end_time

No

Long

Query end timestamp, in milliseconds.

page_size

No

Integer

Maximum number of blocked URLs displayed on a page. The value ranges from 1 to 50. page_size and page_number must be both specified. Default value: 10.

page_number

No

Integer

Number of the page to be queried. The value ranges from 1 to 65,535. Default value: 1.

url

No

String

Blocked URLs.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

total

Integer

Total number of queried records.

ban_urls

Array of BanUrlList objects

URL information.

Table 4 BanUrlList

Parameter

Type

Description

type

String

Block type.

url

String

URL information.

create_time

Long

Creation timestamp, in milliseconds.

modify_time

Long

Update timestamp, in milliseconds.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

GET https://cdn.myhuaweicloud.com/v1.0/cdn/content/ban-urls

Example Responses

Status code: 200

Successful response.

{
  "total" : 1,
  "ban_urls" : [ {
    "type" : "static",
    "url" : "http://www.example.com/1.txt",
    "create_time" : 1652325740318,
    "modify_time" : 1652325740318
  } ]
}

Status Codes

Status Code

Description

200

Successful response.

400

Error response.

Error Codes

See Error Codes.