All Products
Search
Document Center

Cloud Storage Gateway:DescribeGatewayLogging

Last Updated:Jun 24, 2025

Queries the logging configurations of a gateway, including the logging status, Simple Log Service (SLS) project name, and Logstore name.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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
hcs-sgw:DescribeGatewayLoggingget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
GatewayIdstringYes

The gateway ID.

gw-000eg44nmxbsfwb***

Response parameters

ParameterTypeDescriptionExample
object
SlsProjectstring

The project name.

123***
RequestIdstring

The request ID.

17D08346-BD08-4107-BFBC-01A6AAD5F5FB
Messagestring

The returned message.

successful
GatewayLoggingStatusstring

The logging status of the gateway. Valid values:

  • None: Logging is not configured for the gateway.
  • Enabled: Logging is enabled.
  • Disabled: Logging is disabled.
Enabled
SlsLogstorestring

The Logstore name.

alex***
Codestring

The status code. The status code 200 indicates that the request was successful.

200
Successboolean

Indicates whether the request was successful.

true

Examples

Sample success responses

JSONformat

{
  "SlsProject": "123***",
  "RequestId": "17D08346-BD08-4107-BFBC-01A6AAD5F5FB",
  "Message": "successful",
  "GatewayLoggingStatus": "Enabled",
  "SlsLogstore": "alex***",
  "Code": 200,
  "Success": true
}

Error codes

HTTP status codeError codeError messageDescription
400EmptyGatewayIdYou must enter a valid ID for the gateway.You must enter a valid ID for the gateway.
400GatewayNotExistThe specified gateway does not exist. You must specify a valid parameter.The specified gateway does not exist. You must specify a valid parameter.

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

Change history

Change timeSummary of changesOperation
No change history