# 查询已封禁的URL - ListBanUrl
#### 功能介绍
查询已封禁的URL，如需使用本接口，请提交工单申请。
- 单租户调用频率：30次/s。
  
 
#### 调用方法
请参见[如何调用API](https://support.huaweicloud.com/api-cdn/cdn_02_0019.html)。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-cdn/cdn_02_0020.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                                    | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | cdn:contentgateway:queryBanHistoryTask | List | -           | -   | -  | -      |
     
  
 
#### URI
GET /v1.0/cdn/content/ban-urls
表1Query参数 
| 参数          | 是否必选 | 参数类型    | 描述                                                           |
|:---|:---|:---|:---|
| start_time  | 否    | Long    | 查询起始时间戳（毫秒）。                                                 |
| end_time    | 否    | Long    | 查询结束时间戳（毫秒）。                                                 |
| page_size   | 否    | Integer | 封禁的url所显示单页最大数量，取值范围为1-50。page_size和page_number必须同时传值。默认值10. |
| page_number | 否    | Integer | 封禁的url当前查询为第几页，取值范围为1-65535。默认值1                             |
| url         | 否    | String  | 封禁的url地址。                                                    |
   
#### 请求参数
表2请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                      |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
   
#### 响应参数
**状态码：200**
表3响应Body参数 
| 参数       | 参数类型                                                            | 描述      |
|:---|:---|:---|
| total    | Integer                                                         | 查询结果总数。 |
| ban_urls | Array of [BanUrlList] objects | url信息。  |
   
 表4BanUrlList 
| 参数          | 参数类型   | 描述         |
|:---|:---|:---|
| type        | String | 封禁类型。      |
| url         | String | url信息。     |
| create_time | Long   | 创建时间戳（毫秒）。 |
| modify_time | Long   | 更新时间戳（毫秒）。 |
   
**状态码：400**
表5响应Body参数 
| 参数         | 参数类型   | 描述   |
|:---|:---|:---|
| error_code | String | 错误码  |
| error_msg  | String | 错误描述 |
   
#### 请求示例
```
GET https://cdn.myhuaweicloud.com/v1.0/cdn/content/ban-urls
```
#### 响应示例
**状态码：200**
成功响应。
```
{
  "total" : 1,
  "ban_urls" : [ {
    "type" : "static",
    "url" : "http://www.example.com/1.txt",
    "create_time" : 1652325740318,
    "modify_time" : 1652325740318
  } ]
}
```
#### SDK代码示例
SDK代码示例如下。
- [Java]
  ```
  package com.huaweicloud.sdk.test;
  import com.huaweicloud.sdk.core.auth.ICredential;
  import com.huaweicloud.sdk.core.auth.GlobalCredentials;
  import com.huaweicloud.sdk.core.exception.ConnectionException;
  import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
  import com.huaweicloud.sdk.core.exception.ServiceResponseException;
  import com.huaweicloud.sdk.cdn.v2.region.CdnRegion;
  import com.huaweicloud.sdk.cdn.v2.*;
  import com.huaweicloud.sdk.cdn.v2.model.*;
  public class ListBanUrlSolution {
      public static void main(String[] args) {
          // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
          // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
          String ak = System.getenv("CLOUD_SDK_AK");
          String sk = System.getenv("CLOUD_SDK_SK");
          ICredential auth = new GlobalCredentials()
                  .withAk(ak)
                  .withSk(sk);
          CdnClient client = CdnClient.newBuilder()
                  .withCredential(auth)
                  .withRegion(CdnRegion.valueOf("<YOUR REGION>"))
                  .build();
          ListBanUrlRequest request = new ListBanUrlRequest();
          try {
              ListBanUrlResponse response = client.listBanUrl(request);
              System.out.println(response.toString());
          } catch (ConnectionException e) {
              e.printStackTrace();
          } catch (RequestTimeoutException e) {
              e.printStackTrace();
          } catch (ServiceResponseException e) {
              e.printStackTrace();
              System.out.println(e.getHttpStatusCode());
              System.out.println(e.getRequestId());
              System.out.println(e.getErrorCode());
              System.out.println(e.getErrorMsg());
          }
      }
  }
  ```
- [Python]
  ```
  # coding: utf-8
  import os
  from huaweicloudsdkcore.auth.credentials import GlobalCredentials
  from huaweicloudsdkcdn.v2.region.cdn_region import CdnRegion
  from huaweicloudsdkcore.exceptions import exceptions
  from huaweicloudsdkcdn.v2 import *
  if __name__ == "__main__":
      # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
      # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
      ak = os.environ["CLOUD_SDK_AK"]
      sk = os.environ["CLOUD_SDK_SK"]
      credentials = GlobalCredentials(ak, sk)
      client = CdnClient.new_builder() \
          .with_credentials(credentials) \
          .with_region(CdnRegion.value_of("<YOUR REGION>")) \
          .build()
      try:
          request = ListBanUrlRequest()
          response = client.list_ban_url(request)
          print(response)
      except exceptions.ClientRequestException as e:
          print(e.status_code)
          print(e.request_id)
          print(e.error_code)
          print(e.error_msg)
  ```
- [Go]
  ```
  package main
  import (
  "fmt"
  "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global"
      cdn "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cdn/v2"
  "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cdn/v2/model"
      region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cdn/v2/region"
  )
  func main() {
      // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
      // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
      ak := os.Getenv("CLOUD_SDK_AK")
      sk := os.Getenv("CLOUD_SDK_SK")
      auth, err := global.NewCredentialsBuilder().
          WithAk(ak).
          WithSk(sk).
          SafeBuild()
      if err != nil {
          fmt.Println(err)
          return
      }
      hcClient, err := cdn.CdnClientBuilder().
           WithRegion(region.ValueOf("<YOUR REGION>")).
           WithCredential(auth).
           SafeBuild()
      if err != nil {
          fmt.Println(err)
          return
      }
      client := cdn.NewCdnClient(hcClient)
      request := &model.ListBanUrlRequest{}
  response, err := client.ListBanUrl(request)
  if err == nil {
          fmt.Printf("%+v\n", response)
      } else {
          fmt.Println(err)
      }
  }
  ```
- [更多]
  更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CDN/sdk?api=ListBanUrl&version=v2)的代码示例页签，可生成自动对应的SDK代码示例。
#### 状态码
| 状态码 | 描述    |
|:---|:---|
| 200 | 成功响应。 |
| 400 | 错误响应。 |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-cdn/ErrorCode.html)。