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
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Project ID. Minimum: 1 Maximum: 1024 |
Request 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 |
| 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
| 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"
} Example Responses
None
SDK Sample Code
The SDK sample code is as follows.
This API is used to check the format of the URL source list file.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 | 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()); } } } |
This API is used to check the format of the URL source list file.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 | # 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) |
This API is used to check the format of the URL source list file.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 | 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) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
| Status Code | Description |
|---|---|
| 200 | No response body is returned if the verification is successful. |
| 400 | Standard error response. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot