Checking the Format of the URL Source List File

Function

Check whether the format of the URL source list file is valid.

Calling Method

For details, see Calling APIs.

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, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
oms::checkUrlSourceListFileFormat	Read	-	-	-	-

URI

POST /v2/{project_id}/objectstorage/buckets/url-source-list-file

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. Minimum: 1 Maximum: 1024

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	The token used for IAM authentication. Ensure that the project ID in the token matches the project ID in the request URI. Minimum: 1 Maximum: 16384

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
obs_bucket	Yes	String	The name of the OBS bucket for storing the object list files. Ensure that the OBS bucket is in the same region as the destination bucket, or the task will fail to be created. Minimum: 0 Maximum: 1024
list_file_key	Yes	String	The object names in the object list file or URL list file. Minimum: 1 Maximum: 1024
ak	Yes	String	The AK for accessing the destination bucket. Enter a maximum of 100 characters. Minimum: 0 Maximum: 100
sk	Yes	String	The SK for accessing the destination bucket. Enter a maximum of 100 characters. Minimum: 0 Maximum: 100
region	Yes	String	Region where the bucket is located.

Response Parameters

Status code: 200

No response body is returned if the verification is successful.

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_msg	String	Error message.
error_code	String	Error code.

Example Requests

This API is used to check the format of the URL source list file.

POST https://{endpoint}/v2/{project_id}/tasks/url-source-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"
}