All Products
Search
Document Center

Microservices Engine:PreserveHeaderFormat

Last Updated:Nov 20, 2024

Specifies whether to convert all letters of a header into lowercase letters. For requests and responses, HTTP/1.1 headers are not case-sensitive. By default, all letters of headers are converted into lowercase letters.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
mse:PreserveHeaderFormatget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
GatewayUniqueIdstringYes

The unique ID of the gateway.

gw-3f97e2989c344f35ab3fd62b19f1****
PreserveHeaderFormatbooleanYes

Specifies whether the request header is case-sensitive. Valid values:

  • true
  • false
true
AcceptLanguagestringNo

The language in which you want to display the results. Valid values: zh and en. zh indicates Chinese, which is the default value. en indicates English.

zh

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

69AD2AA7-DB47-449B-941B-B14409DF****
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
Codeinteger

The status code. A value of 200 is returned if the request is successful.

200
ErrorCodestring

The status code.

Success
HttpStatusCodeinteger

The HTTP status code.

200
Messagestring

The message returned.

OK
DynamicCodestring

The dynamic part in the error message.

code
DynamicMessagestring

The dynamic part in the error message. This parameter is used to replace the **%s** variable in the ErrMessage parameter.

Note The request parameter DtsJobId is invalid if The Value of Input Parameter %s is not valid is returned for ErrMessage and DtsJobId is returned for DynamicMessage.
The specified parameter is invalid.
Databoolean

The returned data.

true

Examples

Sample success responses

JSONformat

{
  "RequestId": "69AD2AA7-DB47-449B-941B-B14409DF****",
  "Success": true,
  "Code": 200,
  "ErrorCode": "Success",
  "HttpStatusCode": 200,
  "Message": "OK",
  "DynamicCode": "code",
  "DynamicMessage": "The specified parameter is invalid.",
  "Data": true
}

Error codes

HTTP status codeError codeError messageDescription
400IllegalRequestInvalid request:%sInvalid request: %s
400InvalidParameterParameter error:%sRequest parameter error: %s
403NoPermissionYou are not authorized to perform this operation:%sYou do not have the permission to use this interface:%s
404NotFoundNot found:%sThe resource does not exist:%s
500InternalErrorConsole error. Try again later:%sConsole error. Try again later: %s

For a list of error codes, visit the Service error codes.