All Products
Document Center


Last Updated:May 28, 2024

Applies for a public endpoint for an ApsaraDB for Redis instance.

Operation description

You can also apply for public endpoints in the ApsaraDB for Redis console. For more information, see Use a public endpoint to connect to an ApsaraDB for Redis instance.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:
    • The required resource types are displayed in bold characters.
    • 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.
OperationAccess levelResource typeCondition keyAssociated operation
  • DBInstance

Request parameters


The ID of the instance.


The prefix of the public endpoint. The prefix must start with a lowercase letter and can contain lowercase letters and digits. The prefix can be 8 to 40 characters in length.

Note The endpoint is in the <prefix> format.

The service port number of the instance. Valid values: 1024 to 65535.


Response parameters


The ID of the request.



Sample success responses


  "RequestId": "20C8341E-B5AD-4B24-BD82-D73241522ABF"

Error codes

HTTP status codeError codeError messageDescription
400MissingInstanceIdInstanceId is mandatory for this action.-
400MissingConnectionStringConnectionStringPrefix is mandatory for this action.-
400MissingPortPort is mandatory for this action.-
400NetTypeExistsSpecified net type already existed.-
400InvalidConnectionString.FormatSpecified connection string is not valid.The connection string is invalid. Use a different one.

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

Change history

Change timeSummary of changesOperation
2024-02-26API Description Update. The Error code has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Error CodesThe Error code has changed.
    Error Codes 400 change
    Added Error Codes: 403