Checks whether the configurations of an express synchronization group are valid. If the configurations are invalid, an error message is returned.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ValidateExpressSyncConfig

The operation that you want to perform. Set the value to ValidateExpressSyncConfig.

BucketName String Yes alex***

The name of the Object Storage Service (OSS) bucket.

BucketRegion String Yes cn-hangzhou

The region where the OSS bucket resides.

Name String Yes sync***

The name of the express synchronization group.

BucketPrefix String No test***

The subdirectory of the OSS bucket.

Response parameters

Parameter Type Example Description
Code String 200

The HTTP status code. If the request is successful, 200 is returned.

IsValid Boolean false

Indicates whether the check is successful.

Message String successful

The description of the status code.

RequestId String 943856D2-814B-487A-B645-D5F9CCA15929

The ID of the request.

Success Boolean true

Indicates whether the request is successful.

ValidateMessage String ConflictExpressSyncConfig

Indicates whether the configurations are valid. Valid values:

  • false: An error message is returned.
  • true: No value is returned.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ValidateExpressSyncConfig
&BucketName=alex***
&BucketRegion=cn-hangzhou
&Name=sync***
&<Common request parameters>

Sample success responses

XML format

<ValidateExpressSyncConfigResponse>
      <Message>successful</Message>
      <RequestId>943856D2-814B-487A-B645-D5F9CCA15929</RequestId>
      <ValidateMessage>ConflictExpressSyncConfig</ValidateMessage>
      <Code>200</Code>
      <Success>true</Success>
      <IsValid>false</IsValid>
</ValidateExpressSyncConfigResponse>

JSON format

{
    "Message":"successful",
    "RequestId":"943856D2-814B-487A-B645-D5F9CCA15929",
    "ValidateMessage":"ConflictExpressSyncConfig",
    "Code":"200",
    "Success":true,
    "IsValid":false
}

Error codes

HttpCode Error code Error message Description
400 EmptyExpressSyncName You must enter a valid name for the sync group. The error message returned because the name of the express synchronization group is not specified.
400 EmptyBucketName You must enter a valid name for the bucket. The error message returned because the name of the OSS bucket is not specified.
400 EmptyBucketRegion You must specify a valid region for the bucket. The error message returned because the region of the OSS bucket is not specified.
400 InvalidExpressSyncName The specified name for the sync group is invalid. The name must be 1 to 128 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter. The error message returned because the name of the express synchronization group is invalid. The name must be 1 to 128 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). In addition, it must start with a letter.
400 DuplicateExpressSyncName The specified name of the sync group already exists. Try again later after you specify a valid parameter. The error message returned because the name of the express synchronization group already exists. Check the parameter and try again.
400 ConflictExpressSyncConfig The parameter you specified for the sync group is invalid. Try again later after you specify a valid parameter. The error message returned because the configurations of the express synchronization group conflict with each other. Check the parameters and try again.
400 InvalidRegionId The specified RegionId does not exist. You must specify a valid RegionId. The error message returned because the specified RegionId parameter does not exist. Check whether the parameter is valid.
400 InvalidBucketName The specified bucket name is invalid. You must enter a valid bucket name. The error message returned because the name of the OSS bucket is invalid. Check the parameter and try again.

For a list of error codes, visit the API Error Center.