CreateExternalDatabase

Updated at:

Creates an external database.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

hologram:CreateExternalDatabase

list

*All Resource

*

None None

Request syntax

POST /api/v1/instances/{instanceId}/createExternalDatabase HTTP/1.1

Path Parameters

Parameter

Type

Required

Description

Example

instanceId

string

No

The instance ID.

hgprecn-cn-i7m2vxxxx

Request parameters

Parameter

Type

Required

Description

Example

body

object

No

The request body.

databaseName

string

No

The database name.

my_db

comment

string

No

The comment.

for log stat

defaultUserMapping

string

No

Specifies whether to use user mapping.

true

metastoreType

string

No

The metastore type, such as MaxCompute.

Valid values:

  • maxcompute :

    maxcompute

  • dlf-rest :

    dlf-rest

  • dlf :

    dlf

maxcompute

externalConfig

array<object>

No

The configuration parameters. For more information, see CREATE EXTERNAL DATABASE.

object

No

key

string

No

The configuration field name.

mc_project

value

string

No

The configuration field value.

log_sum

Response elements

Element

Type

Description

Example

object

RequestId

string

Id of the request

2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A

Success

string

Indicates whether the operation is successful. Valid values:

  • true: Successful.

  • false: Failed.

true

ErrorCode

string

The error code.

null

ErrorMessage

string

The error message.

null

HttpStatusCode

string

The HTTP status code.

200

Data

boolean

Indicates whether the operation is successful. Valid values:

  • true: Successful.

  • false: Failed.

true

Examples

Success response

JSON format

{
  "RequestId": "2A8DEF6E-067E-5DB0-BAE1-2894266E6C6A\n",
  "Success": "true",
  "ErrorCode": "null",
  "ErrorMessage": "null",
  "HttpStatusCode": "200",
  "Data": true
}

Error codes

HTTP status code

Error code

Error message

Description

403 NoPermission RAM user permission is insufficient, please grant AliyunHologresReadOnlyAccess permission.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.