Create a DBaaS OpenSearch ACL configuration

PUT /dbaas-opensearch/{name}/acl-config

Path parameters

  • name string Required

    Service name

    Minimum length is 0, maximum length is 63.


Body Required

  • acls array[object]

    List of OpenSearch ACLs

    Hide acls attributes Show acls attributes object
    • rules array[object]
      Hide rules attributes Show rules attributes object
      • index string Required

        OpenSearch index pattern

        Maximum length is 249. Format should match the following pattern: [^\s\/]+.

      • OpenSearch permission

        Values are admin, read, deny, readwrite, or write.

    • username string

      Minimum length is 1, maximum length is 64.

  • Enable OpenSearch ACLs. When disabled authenticated service users have unrestricted access.

  • Enable to enforce index rules in a limited fashion for requests that use the _mget, _msearch, and _bulk APIs


  • 200 application/json


    Hide response attributes Show response attributes object


    • id string(uuid)

      Operation ID

    • reason string

      Operation failure reason

      Values are incorrect, unknown, unavailable, forbidden, busy, fault, partial, not-found, interrupted, unsupported, or conflict.

    • Related resource reference

      Hide reference attributes Show reference attributes
      • id string(uuid)

        Reference ID

      • command string

        Command name

    • message string

      Operation message

    • state string

      Operation status

      Values are failure, pending, success, or timeout.

PUT /dbaas-opensearch/{name}/acl-config
curl \
 -X PUT{name}/acl-config \
 -H "Content-Type: application/json" \
 -d '{"acls":[{"rules":[{"index":"string","permission":"admin"}],"username":"string"}],"acl-enabled":true,"extended-acl-enabled":true}'
Request examples
  "acls": [
      "rules": [
          "index": "string",
          "permission": "admin"
      "username": "string"
  "acl-enabled": true,
  "extended-acl-enabled": true
Response examples (200)
  "id": "string",
  "reason": "incorrect",
  "reference": {
    "id": "string",
    "link": "string",
    "command": "string"
  "message": "string",
  "state": "failure"