All Products
Search

This Product

    Data Management:CreateProxy

    Document Center

    Data Management:CreateProxy

    Last Updated:Oct 21, 2024

    Enables the secure access proxy feature for a database instance.

    Operation description

    • The database instance runs the MySQL or MariaDB database engine. For example, the database instance can be an ApsaraDB RDS for MySQL instance, a PolarDB for MySQL cluster, a Distributed Relational Database Service (DRDS) cluster, or an AnalyticDB for MySQL cluster. The database instance can also be a self-managed MySQL or MariaDB database, or a MySQL or MariaDB database in a third-party cloud.
    • The database instance resides in the China (Hangzhou) or China (Beijing) region.
    • You are a Data Management (DMS) administrator, a database administrator (DBA), or the owner of the database instance.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    There is currently no authorization information disclosed in the API.

    Request parameters

    ParameterTypeRequiredDescriptionExample
    InstanceIdlongYes

    The ID of the database instance. You can call the ListInstances or GetInstance operation to query the database instance ID.

    		183****
    UsernamestringYes

    The username of the database account.

    		username
    PasswordstringYes

    The password of the database account.

    		******
    TidlongNo

    The ID of the tenant. You can call the GetUserActiveTenant operation to query the tenant ID.

    		3***

    Response parameters

    ParameterTypeDescriptionExample
    object

    Schema of Response

    RequestIdstring

    The ID of the request.

    		4FFD154E-F57F-5374-B568-D6276F15****
    Successboolean

    Indicates whether the request was successful. Valid values:

    • true: The request was successful.
    • false: The request failed.
    		true
    ErrorMessagestring

    The error message returned.

    		the instance proxy already exists.
    ErrorCodestring

    The error code returned.

    		InvalidParameterValid
    ProxyIdlong

    The ID of the secure access proxy.

    		4**

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "4FFD154E-F57F-5374-B568-D6276F15****",
  "Success": true,
  "ErrorMessage": "the instance proxy already exists.",
  "ErrorCode": "InvalidParameterValid",
  "ProxyId": 0
}

    Error codes

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

    Change history

    Change timeSummary of changesOperation
    2024-03-28The internal configuration of the API is changed, but the call is not affectedView Change Details