All Products
Search

This Product

    Data Management:CreateProxyAccess

    Document Center

    Data Management:CreateProxyAccess

    Last Updated:Nov 28, 2024

    Grants a user the permissions to access a database instance by using the secure access proxy feature.

    Operation description

    • The data security protection feature is enabled for the instance.
    • Your user role is the administrator role, DBA role, or the owner of data security protection for the current 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

    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
    dms:CreateProxyAccesscreate
    *All Resources
    *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    UserIdlongYes

    The ID of the user. You can call the ListUsers or GetUser operation to obtain this parameter.

    		1
    ProxyIdlongYes

    The ID of the security protection agent. You can call the ListProxies or GetProxy operation to obtain this parameter.

    		1
    IndepAccountstringNo

    The database account.

    		xxx
    IndepPasswordstringNo

    The password that is used to log on to the database.

    		xxx
    TidlongNo

    The ID of the tenant. You can call the GetUserActiveTenant or ListUserTenants operation to obtain this parameter.

    		1

    Response parameters

    ParameterTypeDescriptionExample
    object

    Schema of Response

    RequestIdstring

    The ID of the request.

    		0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
    Successboolean

    Indicates whether the call was successful.

    		true
    ErrorMessagestring

    The error message that is returned.

    		UnknownError
    ErrorCodestring

    The error code returned to the query task.

    		200
    ProxyAccessIdlong

    The ID of the security protection authorization. After the security protection agent authorizes the target user, the system automatically generates a security protection authorization ID. The ID is globally unique.

    		1

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "200",
  "ProxyAccessId": 1
}

    Error codes

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

    Change history

    Change timeSummary of changesOperation
    No change history