# Alibaba Cloud Simple Log Service API

> Alibaba Cloud Simple Log Service API on Apizie: 247 endpoints (Applies a Logtail configuration to a machine group, Invokes an observability AI tool. Tool capabilities are continuously updated. You can retrieve the currently…, Changes the resource group to which a resource belongs, A consumer sends a heartbeat to the server to maintain its active status, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:aliyun-sls/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-sls`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/sls
- Page: https://zieapi.vercel.app/api/cloud/aliyun-sls
- OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-sls/openapi.json

Alibaba Cloud OpenAPI for Simple Log Service (sls, version 2020-12-30). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Applies a Logtail configuration to a machine group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/apply-config-to-machine-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| machineGroup | string | yes | The name of the machine group |
| configName | string | yes | The name of the Logtail configuration |

### Invokes an observability AI tool. Tool capabilities are continuously updated. You can retrieve the currently…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/call-ai-tools` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| params | object | no | The tool parameters |
| regionId | string | no | The target region |
| toolName | string | yes | The name of the tool. This parameter is required. It is used to identify and reference the tool and must be unique within the workspace |

### Changes the resource group to which a resource belongs
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/change-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | no | The project to which the resource belongs |
| resourceGroupId | string | yes | The ID of the resource group |
| resourceId | string | yes | The ID of the resource |
| resourceType | string | no | The type of the resource. Only PROJECT is supported. Set the value to PROJECT |

### A consumer sends a heartbeat to the server to maintain its active status
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/consumer-group-heart-beat` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| logstore | string | yes | The name of the Logstore |
| consumerGroup | string | yes | The name of the consumer group. The name must be unique within a project |
| consumer | string | yes | The consumer |
| body | array | yes | The list of shard IDs that are being consumed |

### Updates the checkpoint of a shard for a consumer group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/consumer-group-update-check-point` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| logstore | string | yes | The name of the Logstore |
| consumerGroup | string | yes | The name of the consumer group |
| consumer | string | yes | The consumer |
| forceSuccess | string | no | Specifies whether to enable forceful updates. Valid values: true false |
| checkpoint | string | yes | The value of the checkpoint |
| shard | integer | yes | The ID of the shard |

### Creates a process-level configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/create-agent-instance-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| attributes | object | no | The process that the configuration applies to |
| config | string | yes | The default configurations |
| configType | string | yes | The type of the process-level configuration |
| grayConfigs | array | no | The canary release environment |

### Creates an alert rule in a project
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/create-alert` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| configuration | object | yes | The detailed configurations of the alert rule |
| description | string | no | The description of the alert rule |
| displayName | string | yes | The display name of the alert rule |
| name | string | yes | The name of the alert rule. Make sure that the name is unique in a project |
| schedule | object | yes | The scheduling configurations of the alert rule |

### Creates a dataset
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/create-annotation-data-set` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| createBy | string | no | The creator |
| createTime | integer | no | The creation time |
| dataType | string | no | The type of the data |
| datasetId | string | no | The unique identifier of the dataset |
| description | string | no | The description of the dataset |
| labelId | string | no | The ID of the tag system that corresponds to the dataset |
| lastModifyTime | integer | no | The last modification time |
| name | string | no | The name of the dataset |
| settingType | string | no | The configuration type of the tag table |

### Creates an annotation label table
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/create-annotation-label` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| createTime | integer | no | The creation time |
| description | string | no | The description of the tag table |
| labelId | string | no | The unique identifier of the tag table |
| lastModifyTime | integer | no | The last modification time |
| name | string | no | The name of the tag table |
| settings | array | no | The configurations of the tag tables |
| type | string | no | The type of the tag table |

### Creates an ApiKey resource in a specified project
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/create-api-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| allowedStores | array | no | The list of Logstores that the API key is allowed to write to |
| apiKeyName | string | no | The API key name |
| description | string | no | The description |
| project | string | no | The project name |

### Creates an Azure Blob import task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/create-azure-blob-ingestion` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| configuration | object | yes | The Azure Blob import configuration |
| description | string | no | The description of the task |
| displayName | string | yes | The display name of the Azure Blob task |
| name | string | yes | The name of the Azure Blob import task |
| schedule | object | no | The scheduling type. You do not need to specify this parameter in most cases |

### Creates a Logtail configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/create-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| configName | string | yes | The name of the Logtail configuration. The name must be unique within the project to which the configuration belongs. The name cannot be… |
| createTime | integer | no | The time when the Logtail configuration was created. This value is a UNIX timestamp representing the number of seconds that have elapsed… |
| inputDetail | object | yes | The configuration of the log input. For more information, see https://help.aliyun.com/document_detail/29058.html |
| inputType | string | yes | The method of log input. Valid values: plugin: Collects logs such as MySQL Binlog by using Logtail plugins. file: Collects logs from text… |
| lastModifyTime | integer | no | The time when the Logtail configuration was last updated. This value is a UNIX timestamp representing the number of seconds that have… |
| logSample | string | no | The log sample |
| outputDetail | object | yes | The configuration of the log output. For more information, see https://help.aliyun.com/document_detail/29058.html |
| outputType | string | yes | The method of log output. Only LogService is supported, which means data can only be uploaded to Simple Log Service |

### Creates a consumer group for a Logstore
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/create-consumer-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| logstore | string | yes | The name of the Logstore |
| project | string | yes | The name of the project |
| consumerGroup | string | yes | The name of the consumer group. The name must be unique in a project |
| order | string | yes | Specifies whether to consume data in sequence. Valid values: true In a shard, data is consumed in ascending order based on the value of… |
| timeout | integer | yes | The timeout period. If the server does not receive heartbeats from a consumer within the timeout period, the server deletes the consumer.… |

### Creates a dashboard
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/create-dashboard` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| attribute | object | no | The properties of the dashboard |
| charts | array | yes | The charts in the dashboard |
| dashboardName | string | yes | The internal display name of the dashboard |
| description | string | no | The description of the dashboard |
| displayName | string | yes | The display name of the dashboard |

### Binds a new custom domain name to a project
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/create-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| domainName | string | yes | The domain name |

### Creates a log download task in a specified project
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/create-download-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| configuration | object | yes | The download configuration |
| description | string | no | The description of the log download task |
| displayName | string | yes | The display name |
| name | string | yes | The name of the job. The naming rules are as follows: The name must be unique within the same project. The name can contain only lowercase… |

### Creates a data transformation job in a specified project
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/create-etl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| configuration | object | yes | The detailed configuration of the data transformation job |
| description | string | no | The description of the data transformation job |
| displayName | string | yes | The display name of the data transformation job |
| name | string | yes | The name of the job. The naming rules are as follows: The job name must be unique within the same project. The name can contain only… |

### Creates an ES or OpenSearch import job
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/create-elasticsearch-ingestion` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| configuration | object | yes | The configuration for the ES or OpenSearch import job |
| description | string | no | The description of the job |
| displayName | string | yes | The display name of the job |
| name | string | yes | The unique identifier of the ES or OpenSearch import job |
| schedule | object | no | The schedule structure |

### Creates a GCP Cloud Storage file import job
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/create-gcsingestion` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| configuration | object | yes | The configuration |
| description | string | no | The description of the job |
| displayName | string | yes | The display name |
| name | string | yes | The name of the job. The naming rules are as follows: The job name must be unique within the same project. It can contain only lowercase… |

### Creates an index for a specified Logstore
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/create-index` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| logstore | string | yes | The name of the Logstore |
| project | string | yes | The name of the Project |
| keys | object | no | The field index configuration. The key is the field name, and the value is the field index configuration. At least one of the following… |
| line | object | no | The full-text index configuration. At least one of the following must exist: full-text index, field index, or scan index. Full-text index… |
| log_reduce | string | no | Specifies whether to enable LogReduce. After LogReduce is enabled, at most one of the whitelist and blacklist takes effect. true:… |
| log_reduce_black_list | array | no | The blacklist for filtering clustering fields in LogReduce. This parameter takes effect only when LogReduce is enabled |
| log_reduce_white_list | array | no | The whitelist for filtering clustering fields in LogReduce. This parameter takes effect only when LogReduce is enabled |
| max_text_len | integer | no | Simple Log Service sets the maximum length of a field value to 2,048 bytes (2 KB) by default. To change the maximum length of a field… |
| scan_index | string | no | Specifies whether to enable scan index. At least one of the following must exist: full-text index, field index, or scan index |

### Creates a Kafka import task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/create-kafka-ingestion` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The Simple Log Service project |
| configuration | object | yes | The detailed configuration of the Kafka import task |
| description | string | no | The description of the Kafka import task |
| displayName | string | yes | The display name |
| name | string | yes | The name of the Kafka import task |
| schedule | object | no | The scheduling structure |

### Creates a Logstore
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/create-log-store` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| appendMeta | string | no | Specifies whether to record the public IP address and log receiving time. Default value: false. true: enables the feature to record the… |
| autoSplit | string | no | Specifies whether to enable automatic sharding. After this feature is enabled, if the log write traffic continuously exceeds the limit,… |
| enableModify | string | no | Specifies whether to enable the log modification and deletion feature |
| enable_tracking | string | no | Specifies whether to enable the WebTracking feature. Default value: false. You can use the WebTracking feature to collect and analyze user… |
| encrypt_conf | object | no | The encryption configuration structure, which includes the enable, encrypt_type, and user_cmk_info parameters. For more information, see… |
| hot_ttl | integer | no | The storage duration of data in the hot tier of the Logstore. Unit: days. Minimum value: 7. The maximum value cannot exceed the value of… |
| infrequentAccessTTL | integer | no | The storage duration in the IA tier. No minimum storage duration is required. Data is transferred to the archive tier after being stored… |
| logstoreName | string | yes | The name of the Logstore. The name must meet the following rules: The name must be unique in the project. The name can contain only… |
| maxSplitShard | integer | no | The maximum number of shards that can be automatically split. Minimum value: 1. Maximum value: 256. This parameter is required when the… |
| mode | string | no | Simple Log Service provides two types of Logstores: Standard and Query. standard: supports the all-in-one data analytics feature of Simple… |
| processorId | string | no | IngestProcessor ID |
| resourceGroupId | string | no | The ID of the resource group. After you specify this parameter, the Logstore is associated with the resource group |
| shardCount | integer | yes | The number of shards. You cannot use this API operation to update the number of shards. You can change the number of shards only by… |
| shardingPolicy | object | no | The hash-based write configuration. When data is written, logs are stored in shards based on the configured hash policy. Before… |
| telemetryType | string | no | The observable data type. Default value: log data. Valid values: None: log data. This is the default value. Metrics: time series data |
| ttl | integer | yes | The data retention period. Unit: days. Valid values: 1 to 3650. A value of 3650 indicates permanent retention |

### Enables the service log feature for a project
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/create-logging` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| loggingDetails | array | yes | The configurations of service logs |
| loggingProject | string | yes | The name of the project to which service logs are stored |

### Creates a Logtail pipeline configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/create-logtail-pipeline-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| aggregators | array | no | The list of aggregation plugins. > This parameter is valid only when you use extension processing plugins. You can use a maximum of one… |
| configName | string | yes | The name of the configuration. The configuration name must be unique within the project and cannot be modified after the configuration is… |
| flushers | array | yes | The list of output plugins. > Currently, you can add only one flusher_sls plugin.> |
| global | object | no | The global configuration |
| inputs | array | yes | The list of input plugins. > Currently, you can configure only one input plugin.> |
| logSample | string | no | A sample log. Multiple log entries are supported |
| processors | array | no | The list of processing plugins. Processing plugins are classified into native processing plugins and extension processing plugins. For… |
| task | object | no | The task configuration |

### Creates a machine group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/create-machine-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| groupAttribute | object | no | The attributes of the machine group |
| groupName | string | yes | The name of the machine group. The name must meet the following requirements: The name of each machine group in a project must be unique.… |
| groupType | string | no | The type of the machine group. The parameter can be left empty |
| machineIdentifyType | string | yes | The type of the machine group identifier. Valid values: ip: The machine group uses IP addresses as identifiers. userdefined: The machine… |
| machineList | array | yes | The identifiers of machine group. If you set machineIdentifyType to ip, enter the IP address of the machine. If you set… |

### Creates a materialized view
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/create-materialized-view` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | no | The name of the project |
| aggIntervalMins | integer | no | The result aggregation interval of the materialized view |
| logstore | string | no | The name of the Logstore |
| name | string | no | The name of the materialized view |
| originalSql | string | no | The original SQL query statement executed by the materialized view |
| shardCount | integer | no | The number of shards |
| startTime | integer | no | The start time |
| ttl | integer | no | The retention period, in days |

### Creates a MaxCompute data shipping job
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/create-max-compute-export` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| configuration | object | yes | The job configuration |
| description | string | no | The job description |
| displayName | string | yes | The display name of the job |
| name | string | yes | The unique identifier of the MaxCompute data shipping job |

### Creates a Metricstore to store metrics
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/create-metric-store` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| appendMeta | string | no | Specifies whether to record the public IP address of the client. The default value is false. true: Records the public IP address. false:… |
| autoSplit | string | no | Specifies whether to enable automatic shard splitting |
| hot_ttl | integer | no | The period for which data is stored in the hot tier. Unit: days. The value must be at least 7 and cannot be greater than the value of ttl.… |
| infrequentAccessTTL | integer | no | The retention period of data in the IA storage class. Unit: days. The minimum value is 30. After this period, data is moved to Archive… |
| maxSplitShard | integer | no | The maximum number of shards into which a shard can be split. This parameter is valid only if autoSplit is set to true |
| metricType | string | no | The type of the Metricstore. Only prometheus is supported. The default value is prometheus |
| mode | string | no | The type of the Metricstore. Only standard is supported. The default value is standard |
| name | string | yes | The name of the Metricstore to create |
| shardCount | integer | yes | The number of https://help.aliyun.com/document_detail/28976.html for the Metricstore |
| shardingPolicy | object | no | The write hashing configuration |
| ttl | integer | yes | The data retention period of the Metricstore. Unit: days |

### Delivers logs from a Logstore to an OSS bucket by using LogShipper
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/create-ossexport` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| configuration | object | yes | The job configuration |
| description | string | no | The job description |
| displayName | string | yes | The display name of the job |
| name | string | yes | The name of the job. The naming rules are as follows: The name must be unique within the same project. The name can contain only lowercase… |

### Creates an OSS-HDFS data shipping job in a specified project
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/create-osshdfsexport` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| configuration | object | yes | The job configuration |
| description | string | no | The job description |
| displayName | string | yes | The display name of the job |
| name | string | yes | The name of the job. The naming rules are as follows: The job name must be unique within the same project. The name can contain only… |

### Creates an OSS import job in a specified project
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/create-ossingestion` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| configuration | object | yes | The OSS import configuration |
| description | string | no | The description of the job |
| displayName | string | yes | The display name |
| name | string | yes | The name of the job. The name must meet the following requirements: The job name must be unique within the same project. The name can… |
| schedule | object | no | The scheduling type. You do not need to specify this parameter in most cases. If you have strict scheduling requirements, such as… |

### Creates a project
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/create-project` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| dataRedundancyType | string | no | The disaster recovery type. Valid values: LRS: locally redundant storage ZRS: zone-redundant storage |
| description | string | yes | The description of the project |
| projectName | string | yes | The project name must be unique in a region. You cannot change the name after you create the project. The name must meet the following… |
| recycleBinEnabled | string | no | Specifies whether to enable the recycle bin feature. Valid values: true false |
| resourceGroupId | string | no | The ID of the resource group |

### Creates a resource record
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/create-resource-record` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| resourceName | string | yes | The resource name |
| createTime | integer | no | The record creation time, a UNIX timestamp in seconds. This field is returned only in responses |
| id | string | no | The record ID. If this field is not specified during creation or batch write, the server automatically generates it. If specified, the… |
| lastModifyTime | integer | no | The record last modification time, a UNIX timestamp in seconds. This field is returned only in responses |
| tag | string | no | The record tag |
| value | string | yes | The record content, which is a string encoded from a JSON object |

### Creates an S3 file import task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/create-s3-ingestion` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| configuration | object | no | The configuration |
| description | string | no | The description of the task |
| displayName | string | yes | The display name |
| name | string | yes | The name of the job. The naming rules are as follows: The job name must be unique within the same project. It can contain only lowercase… |
| schedule | object | no | The scheduling structure |

### Creates a saved search
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/create-saved-search` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| displayName | string | yes | The display name |
| logstore | string | yes | The name of the Logstore to which the saved search belongs |
| savedsearchName | string | yes | The name of the saved search. The name must be 3 to 63 characters in length |
| searchQuery | string | yes | The query statement of the saved search. A query statement consists of a search statement and an analytic statement in the `Search… |
| topic | string | yes | The topic of the logs |
| project | string | yes | The name of the project |

### Creates a scheduled SQL job in a specified project
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/create-scheduled-sql` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| configuration | object | yes | The job configuration |
| description | string | no | The job description |
| displayName | string | yes | The display name of the job |
| name | string | yes | The name of the job. The naming rules are as follows: The job name must be unique within the same project. The name can contain only… |
| schedule | object | yes | The scheduling configuration of the job |

### If you use Standard SQL to analyze a large volume of data, a single query may not be able to scan all logs…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/create-sql-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project for which you want to enable Dedicated SQL |
| cu | integer | yes | The number of compute units (CUs). CUs are the compute cores that can be used in parallel when Dedicated SQL is running |
| useAsDefault | string | yes | Specifies whether to enable Dedicated SQL by default for the project. If you set this parameter to \`true\`, all query and analysis… |

### Creates a storeview
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/create-store-view` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| name | string | yes | The name of the storeview. The name can contain only lowercase letters, digits, and underscores (_). The name must start with a lowercase… |
| storeType | string | yes | The type of the storeview. Valid values: metricstore: storeview for Metricstore. logstore: storeview for Logstore |
| stores | array | yes | The list of Logstores or Metricstores |

### Obtains a ticket. Simple Log Service allows you to share the query and analysis pages and dashboard pages…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/create-ticket` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |

### Deletes a process configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/delete-agent-instance-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| configType | string | yes | The type of the process-level configuration |
| attributes | string | no | The process to which the configuration applies (JSON-encoded) |

### Deletes an alert rule
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/delete-alert` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| alertName | string | yes | The ID of the alert rule |

### Deletes data from a dataset
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/delete-annotation-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| datasetId | string | yes | The unique ID of the dataset |
| annotationdataId | string | yes | The unique ID of the data |

### Deletes a dataset. You can delete a dataset only if it contains no data structures
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/delete-annotation-data-set` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| datasetId | string | yes | The unique ID of the dataset |

### Deletes a custom annotation label
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/delete-annotation-label` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| labelId | string | yes | The label ID |

### Deletes a specified ApiKey resource
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/delete-api-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| apiKeyName | string | yes | The ApiKey name |
| project | string | no | The project name |

### Deletes an Azure Blob ingestion task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/delete-azure-blob-ingestion` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| azureBlobIngestionName | string | yes | The name of the Azure Blob ingestion task |

### Deletes a collection rule for cloud service log collection
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/delete-collection-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| policyName | string | yes | The rule name |
| productCode | string | no | The product code |
| dataCode | string | no | The log type code |

### Deletes a Logtail configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/delete-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| configName | string | yes | The name of the Logtail configuration |

### Deletes a consume processor
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/delete-consume-processor` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| processorName | string | yes | The name of the consume processor |

### Deletes a consumer group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/delete-consumer-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| logstore | string | yes | The name of the Logstore |
| consumerGroup | string | yes | The name of the consumer group |

### Deletes a dashboard
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/delete-dashboard` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| dashboardName | string | yes | The name of the dashboard |

### Deletes a custom domain name that is bound to a project
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/delete-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| domainName | string | yes | The domain name to be deleted |

### Deletes a download task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/delete-download-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| downloadJobName | string | yes | The name of the log download task |
| project | string | yes | The name of the project |

### Deletes a data transformation job
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/delete-etl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| etlName | string | yes | The name of the data transformation job |

### Deletes an Elasticsearch or OpenSearch import task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/delete-elasticsearch-ingestion` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| esIngestionName | string | yes | The name of the Elasticsearch or OpenSearch import task |

### Deletes an index of a Logstore
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/delete-index` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| logstore | string | yes | The name of the Logstore |
| project | string | yes | The name of the project |

### Deletes an ingest processor
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/delete-ingest-processor` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| processorName | string | yes | The identifier of the ingest processor |

### Deletes a Kafka import task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/delete-kafka-ingestion` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the Simple Log Service project |
| kafkaIngestionName | string | yes | The name of the Kafka data import task |

### Deletes a Logstore, including all shards and indexes in the Logstore
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/delete-log-store` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| logstore | string | yes | The name of the Logstore |

### Deletes the service log for a specified project
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/delete-logging` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |

### Deletes log data from a Logstore under a specified project
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/delete-logs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| from | integer | yes | The start time of the query. This time refers to the log time specified when the log data was written. The time interval defined by the… |
| query | string | no | Optional: The query statement used to filter the logs to be updated. For more information, see… |
| rowId | string | no | Optional: The value of the built-in field rowid that is automatically returned in the query results. One of rowId and query must be… |
| to | integer | yes | The end time of the query. This time refers to the log time specified when the log data was written. The time interval defined by the… |
| project | string | no | The name of the project |
| logstore | string | yes | Queries data in the Logstore |

### Deletes a Logtail pipeline configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/delete-logtail-pipeline-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| configName | string | yes | The name of the Logtail pipeline configuration |

### Deletes a machine group. If the Logtail configurations for log collection are applied to a machine group,…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/delete-machine-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| machineGroup | string | yes | The name of the machine group |

### Deletes a materialized view
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/delete-materialized-view` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | no | The name of the project |
| name | string | yes | The name of the materialized view |

### Deletes a MaxCompute data shipping job
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/delete-max-compute-export` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| mcExportName | string | yes | The unique name of the MaxCompute data shipping job. Make sure that the job exists |

### Deletes an existing Metricstore. When you delete a Metricstore, the metric data stored in the Metricstore…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/delete-metric-store` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| name | string | yes | The name of the Metricstore |

### Deletes a specified OSS data shipping job
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/delete-ossexport` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| ossExportName | string | yes | The unique name of an existing OSS data shipping job |

### Deletes an OSS-HDFS data shipping job
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/delete-osshdfsexport` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| ossExportName | string | yes | The unique name of the job |

### Deletes an OSS import task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/delete-ossingestion` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The project name |
| ossIngestionName | string | yes | The name of the OSS import task |

### Deletes a specified project
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/delete-project` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| forceDelete | string | no | Specifies whether to force delete the project. When this parameter is set to true, the project bypasses the recycle bin and is permanently… |

### Deletes a project policy
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/delete-project-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | no | The name of the project |

### Deletes resource records in batches
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/delete-resource-record` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| resourceName | string | yes | The resource name |
| ids | string | yes | The IDs of the records to delete. Separate multiple IDs with commas (,). You can specify up to 200 IDs at a time |

### Deletes an S3 ingestion task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/delete-s3-ingestion` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| s3IngestionName | string | yes | The name of the S3 ingestion task |

### Deletes a saved search
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/delete-saved-search` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| savedsearchName | string | yes | The name of the saved search to be deleted |

### Deletes a specified scheduled query
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/delete-scheduled-sql` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| scheduledSQLName | string | yes | The unique name of an existing scheduled query |

### Deletes a specified storeview by name
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/delete-store-view` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| name | string | yes | The name of the storeview |

### Queries the available regions
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sls/describe-regions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| language | string | no | The language for the localName parameter in the response |

### Disables an alert rule
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/disable-alert` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| alertName | string | yes | The ID of the alert rule |

### Disables a specified API key so that it can no longer be used to write data
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/disable-api-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| apiKeyName | string | yes | The name of the API key |
| project | string | no | The name of the project |

### Disables a specified scheduled query
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/disable-scheduled-sql` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| scheduledSQLName | string | yes | The unique name of an existing task |

### Enables an alert rule
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/enable-alert` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| alertName | string | yes | The ID of the alert rule |

### Starts a specified API key so that it can continue to be used for writing data
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/enable-api-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| apiKeyName | string | yes | The API key name |
| project | string | no | The project name |

### Starts the specified scheduled query
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/enable-scheduled-sql` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | A short description of struct |
| scheduledSQLName | string | yes | The unique name of an existing scheduled query |

### Retrieves a process-level configuration
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sls/get-agent-instance-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| configType | string | yes | The type of the process-level configuration |
| attributes | string | no | The owner of the process-level configuration (JSON-encoded) |

### Queries the information about an alert rule
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sls/get-alert` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| alertName | string | yes | The ID of the alert rule |

### Retrieves a data struct from a dataset by its unique identity
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sls/get-annotation-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| datasetId | string | yes | The unique identity of the dataset |
| annotationdataId | string | yes | The unique identity of the data |

### Retrieves information about a dataset
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sls/get-annotation-data-set` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| datasetId | string | yes | The unique ID of the dataset |

### Retrieves a label table by its ID
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sls/get-annotation-label` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| labelId | string | yes | The ID of the label |

### Retrieves the details of a specified API key by API key name
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sls/get-api-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| apiKeyName | string | yes | The API key name |
| project | string | no | The project name |

### Queries the Logtail configurations that are applied to a machine group
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sls/get-applied-configs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| machineGroup | string | yes | The name of the machine group |

### Queries the machine groups to which a Logtail configuration is bound
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sls/get-applied-machine-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| configName | string | yes | The name of the Logtail configuration |

### Retrieves the status and results of an asynchronous SQL query
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sls/get-async-sql` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | no | The name of the project |
| queryId | string | yes | The ID of the asynchronous SQL query. This ID is fixed throughout the SQL lifecycle |
| offset | integer | no | The offset for paginated results |
| line | integer | no | The number of results to return per page. The maximum value is 1000 |

### Retrieves an Azure Blob import task
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sls/get-azure-blob-ingestion` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| azureBlobIngestionName | string | yes | The name of the Azure Blob import task |

### Queries the checkpoints of a shard from which data is consumed by a consumer group
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sls/get-check-point` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| logstore | string | yes | The name of the Logstore |
| consumerGroup | string | yes | The name of the consumer group |
| shard | integer | no | The shard ID. If the specified shard does not exist, an empty list is returned. If no shard ID is specified, the checkpoints of all shards… |

### Retrieves the specified collection policy
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sls/get-collection-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| policyName | string | yes | The name of the policy |
| productCode | string | no | The product code |
| dataCode | string | no | The log type code |

### Calls the GetConfig operation to retrieve the details of a Logtail configuration
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sls/get-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The project name |
| configName | string | yes | The Logtail configuration name |

### Retrieves the details of a consume processor
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sls/get-consume-processor` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| processorName | string | yes | The identifier of the consume processor |

### Queries the contextual logs of a specified log
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sls/get-context-logs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| logstore | string | yes | The name of the Logstore |
| pack_id | string | yes | The unique identifier of the log group to which the start log belongs |
| pack_meta | string | yes | The unique context identifier of the start log in the log group |
| back_lines | integer | yes | The number of logs that you want to obtain and are generated before the generation time of the start log. Valid values: `(0,100]` |
| forward_lines | integer | yes | The number of logs that you want to obtain and are generated after the generation time of the start log. Valid values: `(0,100]` |

### Retrieves a cursor based on a specified time
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sls/get-cursor` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The project name |
| logstore | string | yes | The logstore name |
| shardId | string | yes | The shard ID |
| from | string | yes | A point in time. This can be a UNIX timestamp or the string `begin` or `end` |

### Retrieves the server time that corresponds to a cursor
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sls/get-cursor-time` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The project name |
| logstore | string | yes | The logstore name |
| shardId | string | yes | The shard ID |
| cursor | string | yes | The cursor for which you want to obtain the timestamp. Call the https://help.aliyun.com/document_detail/2771314.html operation to obtain a… |

### Queries a dashboard
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sls/get-dashboard` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| dashboardName | string | yes | The name of the dashboard |

### Retrieves the details of a download task
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sls/get-download-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| downloadJobName | string | yes | The name of the log download task |
| project | string | yes | The name of the project |

### Retrieves the configuration of a specified data transformation job
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sls/get-etl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | no | The name of the project |
| etlName | string | yes | The name of the data transformation job |

### Retrieves an ES/OpenSearch import task
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sls/get-elasticsearch-ingestion` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The project name |
| esIngestionName | string | yes | The ES/OpenSearch task name |

### Retrieves a GCP Cloud Storage file import task
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sls/get-gcsingestion` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The project name |
| gcsIngestionName | string | yes | The name of the GCS import task |

### Queries the distribution of logs that meet the query syntax conditions in a specified Logstore
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sls/get-histograms` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| logstore | string | yes | The name of the Logstore |
| from | integer | yes | The start time of the subinterval. The time is a UNIX timestamp representing the number of seconds that have elapsed since 00:00:00 UTC on… |
| to | integer | yes | The end time of the subinterval. The time is a UNIX timestamp representing the number of seconds that have elapsed since 00:00:00 UTC on… |
| topic | string | no | The topic of the log |
| query | string | no | The query statement. Only query statements are supported. Analytic statements are not supported. For more information about the detailed… |

### Queries the index information of a specified Logstore
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sls/get-index` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The project name |
| logstore | string | yes | The Logstore name |

### Retrieves information about an ingest processor
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sls/get-ingest-processor` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| processorName | string | yes | The identity of the ingest processor |

### Retrieves a job instance
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sls/get-job-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| jobName | string | yes | The job name |
| instanceId | string | yes | The instance ID |
| project | string | no | The project name |
| callerOwner | string | no | The owner of the job |

### Queries the details of a Logstore
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sls/get-log-store` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| logstore | string | yes | The name of the Logstore |
| project | string | yes | The name of the project |

### Retrieves the configuration of a Logstore
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sls/get-log-store-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the Project |
| logstore | string | yes | The name of the Logstore |

### Queries the billing mode of a Logstore
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sls/get-log-store-metering-mode` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| logstore | string | yes | The name of the Logstore |

### Queries the service log configuration of a project
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sls/get-logging` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |

### Queries log data in a specified Logstore of a project. [Deprecated] Use the GetLogsV2 operation instead
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/get-logs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| logstore | string | yes | The Logstore from which to query data |
| Accept-Encoding | string | no | The compression method |
| forward | string | no | Specifies whether to page forward or backward in a scan or phrase query |
| from | integer | yes | The start time of the query. This time refers to the log time specified when log data is written. The time range defined by the from and… |
| highlight | string | no | Specifies whether to enable highlighting |
| isAccurate | string | no | Specifies whether to enable nanosecond-level ordering |
| line | integer | no | The maximum number of logs to return. This parameter is valid only when the query parameter is set to a query statement. Minimum value: 0.… |
| offset | integer | no | The starting line of the query. This parameter is valid only when the query parameter is set to a query statement. Default value: 0 |
| powerSql | string | no | Specifies whether to enable enhanced SQL. Default value: false |
| query | string | no | The query statement or analytic statement. For more information, see Query overview and Analysis overview. To use Dedicated SQL, add set… |
| reverse | string | no | Specifies whether to return logs in descending order of log timestamps, accurate to the minute. Valid values: true: Returns logs in… |
| session | string | no | The query parameters |
| to | integer | yes | The end time of the query. This time refers to the log time specified when log data is written. The time range defined by the from and to… |
| topic | string | no | The log topic |

### Queries raw log data from a specified Logstore in a project and returns raw logs within a specified time…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/get-logs-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The project name |
| logstore | string | yes | The Logstore name |
| Accept-Encoding | string | no | The compression method for the response content. SDK users do not need to specify this parameter because the SDK automatically handles… |
| forward | string | no | Specifies whether to page forward or backward for scan or phrase queries |
| from | integer | yes | The start time of the query. This time refers to the log time specified when log data is written. The time range defined by the from and… |
| highlight | string | no | Specifies whether to enable highlighting |
| isAccurate | string | no | Specifies whether to enable nanosecond-precision ordering |
| line | integer | no | The maximum number of logs to return. This parameter is valid only when the query parameter is a query statement (not an analytic… |
| offset | integer | no | The row from which the query starts. This parameter is valid only when the query parameter is a query statement (not an analytic… |
| powerSql | string | no | Specifies whether to enable Dedicated SQL. Disabled by default |
| query | string | no | The query statement or analytic statement. For more information, see https://help.aliyun.com/document_detail/43772.html and… |
| reverse | string | no | Specifies whether to return logs in reverse chronological order of log timestamps, accurate to the minute level. This parameter is valid… |
| session | string | no | The query parameter |
| to | integer | yes | The end time of the query. This time refers to the log time specified when log data is written. The time range defined by the from and to… |
| topic | string | no | The topic. Default value: empty string |

### Retrieves a Logtail pipeline configuration
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sls/get-logtail-pipeline-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| configName | string | yes | The name of the Logtail pipeline configuration |

### Provides intelligent analysis capabilities for basic data (Log, Metric, Trace) on the Simple Log Service…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/get-mlservice-results` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| serviceName | string | yes | The service name |
| allowBuiltin | string | no | true: The request is allowed to use built-in services. false: The request is not allowed to use built-in services |
| version | string | no | The version of the algorithm. Different versions correspond to different algorithms |
| input | array | no | input |
| parameter | object | no | parameter |

### Gets the details of a machine group
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sls/get-machine-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| machineGroup | string | yes | The name of the machine group |

### Retrieves a materialized view
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sls/get-materialized-view` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | no | The name of the project |
| name | string | yes | The name of the data view |
| returnStatus | string | no | Specifies whether to return the status information of the materialized view |

### Retrieves the information about a MaxCompute data shipping job
`GET https://zieapi.vercel.app/v1/cloud:aliyun-sls/get-max-compute-export` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ap-southeast-1.log.aliyuncs.com |
| project | string | yes | The name of the project |
| mcExportName | string | yes | The unique name of an existing job |

…and 127 more. See the OpenAPI spec.

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-sls/apply-config-to-machine-group" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Simple Log Service API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-sls/apply-config-to-machine-group with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Simple Log Service API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Simple Log Service itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Simple Log Service API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-sls.

### What is the status of the Alibaba Cloud Simple Log Service API?
Needs your own provider key (bring your own key)