CreateGatewayLogging - Cloud Storage Gateway - Alibaba Cloud Documentation Center

Enables log monitoring for a gateway.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that support authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

hcs-sgw:CreateGatewayLogging

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
GatewayId	string	Yes	The gateway ID.	gw-000eg44nmxbsfwbvq***
SlsProject	string	Yes	The SLS project.	alex***
SlsLogstore	string	Yes	The SLS Logstore.	logs***

Response parameters

Parameter	Type	Description	Example
	object
Message	string	The returned message.	successful
RequestId	string	The request ID.	76109369-5729-467D-D4A3-1131A8DA19XX
Code	string	The status code. A status code of 200 indicates that the request was successful.	200
Success	boolean	Indicates whether the call was successful. Valid values: true: The call was successful. false: The call failed.	true

Examples

Success response

JSON format

{
  "Message": "successful",
  "RequestId": "76109369-5729-467D-D4A3-1131A8DA19XX",
  "Code": "200",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	EmptyGatewayId	You must enter a valid ID for the gateway.	You must enter a valid ID for the gateway.
400	EmptySlsProject	You must specify a valid project of Log Service.	You must specify a valid project of Log Service.
400	EmptySlsLogstore	You must specify a valid Logstore of Log Service.	You must specify a valid Logstore of Log Service.
400	GatewayVersionNotAllowed	The specified version for the gateway is invalid. You must specify a valid version.	The specified version for the gateway is invalid. You must specify a valid version.
400	GatewayLoggingStatusNotAllowed	Failed to perform the operation because log monitoring is not enabled.	Failed to perform the operation because log monitoring is not enabled.
400	GatewayNotExist	The specified gateway does not exist. You must specify a valid parameter.	The specified gateway does not exist. You must specify a valid parameter.
400	InvalidLogstore	You must specify a valid project and Logstore of Log Service. The project and Logstore must reside in the same region as the gateway. You can use the project and Logstore to monitor logs.	You must specify a valid project and Logstore of Log Service. The project and Logstore must reside in the same region as the gateway. You can use the project and Logstore to monitor logs.
403	NoPermission	Insufficient permissions. We recommend that you contact the administrator of the Alibaba Cloud account to grant the required permissions to you.	Insufficient permissions. We recommend that you contact the administrator of the Alibaba Cloud account to grant the required permissions to you.
403	AssumeRoleFail	Failed to perform cross-service authorization. Try again later. If the error persists after several tries, we recommend that you submit a ticket.	Failed to perform cross-service authorization. Try again later. If the error persists after several tries, we recommend that you submit a ticket.
404	StorageBundleNotExist	The name you specified for the gateway cluster does not exist. You must specify a valid parameter.	The name you specified for the gateway cluster does not exist. You must specify a valid parameter.
404	RoleNotExist	The role that Cloud Storage Gateway needs to obtain cross-service authorization does not exist. You must grant the required permissions to Cloud Storage Gateway.	The role that Cloud Storage Gateway needs to obtain cross-service authorization does not exist. You must grant the required permissions to Cloud Storage Gateway.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.