GetAuditLogStatus - Key Management Service - Alibaba Cloud Documentation Center

Queries the status of the audit log feature in the current region.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-hsm:GetAuditLogStatus	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region.	cn-hangzhou
GetOssBucket	boolean	No	Specifies whether to obtain the list of OSS buckets that can be used to store audit logs. Valid values: true false	true

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	4C467B38-3910-447D-87BC-AC049166F216
Success	boolean	Indicates whether the request is successful. Valid values: true false	true
RegionId	string	The ID of the region.	cn-hangzhou
AuditLogStatus	string	Indicates whether the audit log feature is enabled. Valid values: enable disable	enable
GrantedServiceAccess	boolean	Indicates whether Cloud Hardware Security Module is authorized to deliver logs. Valid values: true false	true
AuditOssBucket	string	The bucket that stores audit logs.	bucket-test
OssBuckets	array	A list of buckets that can be used to store audit logs.
bucket	string	The name of the bucket.	bucket-test

Examples

Sample success responses

JSONformat

{
  "RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
  "Success": true,
  "RegionId": "cn-hangzhou",
  "AuditLogStatus": "enable",
  "GrantedServiceAccess": true,
  "AuditOssBucket": "bucket-test",
  "OssBuckets": [
    "bucket-test"
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
403	OSSPermissionDenied.Error		-
500	InternalError	The request processing has failed due to some unknown error.	Unknown error caused request processing to fail.

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