
# 检查url来源列表文件格式 - CheckUrlSourceListFileFormat
#### 功能介绍
检查url来源列表文件格式是否有效
#### 调用方法
请参见[如何调用API](https://support.huaweicloud.com/api-oms/oms_api_0006.html)。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-oms/oms_api_8001.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                               | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | oms::checkUrlSourceListFileFormat | Read | -           | -   | -  | -      |
     
  
 
#### URI
POST /v2/{project_id}/objectstorage/buckets/url-source-list-file
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述                                                                                                                            |
|:---|:---|:---|:---|
| project_id | 是    | String | 项目ID 最小长度：**1** 最大长度：**1024** |
   
#### 请求参数
表2请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                     |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | IAM Token认证，需要确认Token中包含的Project ID与请求URI中修改资源的Project ID匹配。 最小长度：**1** 最大长度：**16384** |
   
表3请求Body参数 
| 参数            | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                   |
|:---|:---|:---|:---|
| obs_bucket    | 是    | String | 存放对象列表文件的OBS桶名。 请确保与目的端桶处于同一区域，否则将导致任务创建失败。 最小长度：**0** 最大长度：**1024** |
| list_file_key | 是    | String | 对象列表文件或URL列表文件对象名。 最小长度：**1** 最大长度：**1024**                                                                          |
| ak            | 是    | String | 目的端桶的AK（最大长度100个字符）。 最小长度：**0** 最大长度：**100**                                                                         |
| sk            | 是    | String | 目的端桶的SK（最大长度100个字符）。 最小长度：**0** 最大长度：**100**                                                                         |
| region        | 是    | String | 桶所处的区域。                                                                                                                                                                                                              |
   
#### 响应参数
**状态码：200**
校验通过无响应体。
**状态码：400**
表4响应Body参数 
| 参数         | 参数类型   | 描述    |
|:---|:---|:---|
| error_msg  | String | 错误信息。 |
| error_code | String | 错误码。  |
   
#### 请求示例
检查url来源列表文件格式
```
POST https://{endpoint}/v2/{project_id}/objectstorage/buckets/url-source-list-file
{
  "obs_bucket" : "obs_bucket_name",
  "list_file_key" : "object_list_file.txt",
  "ak" : "access_key_1234",
  "sk" : "secret_key_1234",
  "region" : "cn-north-1"
}
```
#### 响应示例
无
#### SDK代码示例
SDK代码示例如下。
- [Java]
  检查url来源列表文件格式
  ```
  package com.huaweicloud.sdk.test;
  import com.huaweicloud.sdk.core.auth.ICredential;
  import com.huaweicloud.sdk.core.auth.BasicCredentials;
  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.oms.v2.region.OmsRegion;
  import com.huaweicloud.sdk.oms.v2.*;
  import com.huaweicloud.sdk.oms.v2.model.*;
  public class CheckUrlSourceListFileFormatSolution {
      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");
          String projectId = "{project_id}";
          ICredential auth = new BasicCredentials()
                  .withProjectId(projectId)
                  .withAk(ak)
                  .withSk(sk);
          OmsClient client = OmsClient.newBuilder()
                  .withCredential(auth)
                  .withRegion(OmsRegion.valueOf("<YOUR REGION>"))
                  .build();
          CheckUrlSourceListFileFormatRequest request = new CheckUrlSourceListFileFormatRequest();
          CheckUrlSourceListFileFormatReq body = new CheckUrlSourceListFileFormatReq();
          body.withRegion("cn-north-1");
          body.withSk("secret_key_1234");
          body.withAk("access_key_1234");
          body.withListFileKey("object_list_file.txt");
          body.withObsBucket("obs_bucket_name");
          request.withBody(body);
          try {
              CheckUrlSourceListFileFormatResponse response = client.checkUrlSourceListFileFormat(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]
  检查url来源列表文件格式
  ```
  # coding: utf-8
  import os
  from huaweicloudsdkcore.auth.credentials import BasicCredentials
  from huaweicloudsdkoms.v2.region.oms_region import OmsRegion
  from huaweicloudsdkcore.exceptions import exceptions
  from huaweicloudsdkoms.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"]
      projectId = "{project_id}"
      credentials = BasicCredentials(ak, sk, projectId)
      client = OmsClient.new_builder() \
          .with_credentials(credentials) \
          .with_region(OmsRegion.value_of("<YOUR REGION>")) \
          .build()
      try:
          request = CheckUrlSourceListFileFormatRequest()
          request.body = CheckUrlSourceListFileFormatReq(
              region="cn-north-1",
              sk="secret_key_1234",
              ak="access_key_1234",
              list_file_key="object_list_file.txt",
              obs_bucket="obs_bucket_name"
          )
          response = client.check_url_source_list_file_format(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]
  检查url来源列表文件格式
  ```
  package main
  import (
  "fmt"
  "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
      oms "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/oms/v2"
  "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/oms/v2/model"
      region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/oms/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")
      projectId := "{project_id}"
      auth, err := basic.NewCredentialsBuilder().
          WithAk(ak).
          WithSk(sk).
          WithProjectId(projectId).
          SafeBuild()
      if err != nil {
          fmt.Println(err)
          return
      }
      hcClient, err := oms.OmsClientBuilder().
           WithRegion(region.ValueOf("<YOUR REGION>")).
           WithCredential(auth).
           SafeBuild()
      if err != nil {
          fmt.Println(err)
          return
      }
      client := oms.NewOmsClient(hcClient)
      request := &model.CheckUrlSourceListFileFormatRequest{}
  request.Body = &model.CheckUrlSourceListFileFormatReq{
  Region: "cn-north-1",
  Sk: "secret_key_1234",
  Ak: "access_key_1234",
  ListFileKey: "object_list_file.txt",
  ObsBucket: "obs_bucket_name",
  }
  response, err := client.CheckUrlSourceListFileFormat(request)
  if err == nil {
          fmt.Printf("%+v\n", response)
      } else {
          fmt.Println(err)
      }
  }
  ```
- [更多]
  更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/OMS/sdk?api=CheckUrlSourceListFileFormat)的代码示例页签，可生成自动对应的SDK代码示例。
#### 状态码
| 状态码 | 描述        |
|:---|:---|
| 200 | 校验通过无响应体。 |
| 400 | 标准错误响应体。  |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-oms/ErrorCode.html)。
