Delete an index

Prerequisites

• Simple Log Service is activated.

• Simple Log Service SDK for Python is initialized.

• An index is created for the target Logstore. For more information, see Create an index.

Request parameters

The delete_index method uses the following syntax:

def delete_index(self, project_name, logstore_name)

Response parameters

Returns a DeleteIndexResponse object. For more information, see DeleteIndex - Delete an index.

Sample code

from aliyun.log import LogClient, LogException
import os

# Obtain the AccessKey ID and AccessKey secret from environment variables.
access_key_id = os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_ID', '')
access_key_secret = os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_SECRET', '')

# Specify the Simple Log Service endpoint.
# Replace with the endpoint for your region.
endpoint = "cn-hangzhou.log.aliyuncs.com"

# Create a LogClient instance.
client = LogClient(endpoint, access_key_id, access_key_secret)

# Specify the project and Logstore.
project_name = "your-project-name"
logstore_name = "your-logstore-name"


def main():
    try:
        # Delete the index of the specified Logstore.
        response = client.delete_index(project_name, logstore_name)
        response.log_print()
    except LogException as e:
        print(f"Failed to delete index. Error code: {e.get_error_code()}, "
              f"Error message: {e.get_error_message()}, "
              f"Request ID: {e.get_request_id()}")


if __name__ == '__main__':
    main()

Sample response

A successful call returns a DeleteIndexResponse object:

DeleteIndexResponse:
headers: {'Server': 'AliyunSLS', 'Content-Length': '0', 'Connection': 'keep-alive', 'Access-Control-Allow-Origin': '*', 'Date': 'Sat, 12 Oct 2024 08:35:11 GMT', 'x-log-time': '1728722111', 'x-log-requestid': '670A34BF3A127CB513E4****'}

Process finished with exit code 0

Error codes

Common error codes for the delete_index method:

References

• Index management supports the following API operations:

  • CreateIndex

  • GetIndex

  • UpdateIndex

  • DeleteIndex

• For more sample code, see Alibaba Cloud Simple Log Service SDK for Python on GitHub.