All Products
Search
Document Center

Security Center:DescribeLogShipperStatus

Last Updated:Jun 16, 2026

Queries the availability status of the log analysis feature.

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 supports 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

yundun-sas:DescribeLogShipperStatus

get

*LogShipper

acs:yundun-sas:{#regionId}:{#accountId}:logshipper/*

None None

Request parameters

Parameter

Type

Required

Description

Example

From

string

No

The request source identifier. Set this parameter to sas.

sas

Response elements

Element

Type

Description

Example

object

The response object.

RequestId

string

The ID of the request. Alibaba Cloud generates a unique identifier for each request. You can use the ID to troubleshoot issues.

24A20733-10A0-4AF6-BE6B-E3322413****

LogShipperStatus

object

The log delivery status collection.

OpenStatus

string

The enabling status of log analysis. Valid values:

  • yes: enabled

  • no: not enabled.

yes

SlsServiceStatus

string

The activation status of Simple Log Service (SLS). Valid values:

  • yes: activated

  • no: not activated.

yes

AuthStatus

string

The service authorization status of the log analysis feature. Valid values:

  • yes: authorized

  • no: not authorized.

yes

BuyStatus

string

The purchase status of the log analysis feature. Valid values:

  • yes: purchased

  • no: not purchased.

yes

PostPaidSupportStatus

string

The pay-as-you-go support status of the log analysis feature. Valid values:

  • yes: supported

  • no: not supported.

yes

PostPaidOpenStatus

string

The pay-as-you-go activation status of the log analysis feature. Valid values:

  • yes: activated

  • no: not activated.

no

SlsProjectStatus

string

The status of the log project used by the log analysis feature. Valid values:

  • Normal: Normal.

  • Disable: Disabled.

Valid values:

  • normal :

    Normal.

  • training :

    Training.

Normal

EtlMetaVersion

string

The version of the log delivery fields for log analysis. Valid values:

  • SAS_V1

  • SAS_V2.

SAS_V1

Examples

Success response

JSON format

{
  "RequestId": "24A20733-10A0-4AF6-BE6B-E3322413****",
  "LogShipperStatus": {
    "OpenStatus": "yes",
    "SlsServiceStatus": "yes",
    "AuthStatus": "yes",
    "BuyStatus": "yes",
    "PostPaidSupportStatus": "yes",
    "PostPaidOpenStatus": "no",
    "SlsProjectStatus": "Normal",
    "EtlMetaVersion": "SAS_V1"
  }
}

Error codes

HTTP status code

Error code

Error message

Description

500 ServerError ServerError
403 NoPermission caller has no permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.