CreateRdsPostgreSQLDataSource-阿里云帮助中心

Use this API to create an RDS PostgreSQL data source.

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

oceanbase:CreateRdsPostgreSQLDataSource

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Name	string	Yes	The name of the data source.	data_name
InstanceId	string	Yes	The ID of the database instance.	g_abcdefj***
DatabaseName	string	Yes	The name of the database.	db_name
UserName	string	Yes	The name of the database user.	user_name
Password	string	Yes	The Base64-encoded password for the database user.	cGFzc193b3JK
Description	string	No	The description for the data source.	this is a test database

Response elements

Element	Type	Description	Example
	object	The response object.
Success	boolean	Indicates whether the request succeeded.	true
ErrorDetail	object	The details of the error.
Code	string	The error code.	INNER_ERROR
Level	string	The error level. Valid values: `FATAL`, `ERROR`, `WARNING`, and `CRITICAL`.	ERROR
Message	string	The error message.	A system error occurred.
ExtraContext	object	Populates placeholders in the `Message` parameter.
	any	Populates placeholders in the `Message` parameter.	null
MessageMcmsKey	string	The error message key.	null
MessageMcmsContext	object	Populates placeholders in the `MessageMcmsKey` parameter.
	string	Populates placeholders in the `MessageMcmsKey` parameter.	null
Reason	string	The error reason.	null
ReasonMcmsKey	string	The error reason key.	null
ReasonMcmsContext	object	The error reason context.
	string	The error reason context.	null
Proposal	string	A suggestion for resolving the error.	null
ProposalMcmsKey	string	The suggestion key.	null
ProposalMcmsContext	object	The suggestion context.
	string	The suggestion context.	null
UpstreamErrorDetail	any	Details of an error from an upstream service.	null
Code	string	The error code.	INNER_ERROR
Message	string	The error message.	A system error occurred.
Advice	string	A suggestion for resolving the error.	Contact the administrator.
RequestId	string	The request ID.	EE205C00-30E4-**-**-87E3A8A2AA0C
PageNumber	integer	The page number. Returned only for paged queries.	1
PageSize	integer	The number of entries per page. Returned only for paged queries.	10
TotalCount	integer	The total number of entries. Returned only for paged queries.	100
Cost	string	The duration of the request in seconds.	30
Data	string	The ID of the data source.	e_5anwndq

Examples

Success response

JSON format

{
  "Success": true,
  "ErrorDetail": {
    "Code": "INNER_ERROR",
    "Level": "ERROR",
    "Message": "A system error occurred.",
    "ExtraContext": {
      "key": "null"
    },
    "MessageMcmsKey": "null",
    "MessageMcmsContext": {
      "key": "null"
    },
    "Reason": "null",
    "ReasonMcmsKey": "null",
    "ReasonMcmsContext": {
      "key": "null"
    },
    "Proposal": "null",
    "ProposalMcmsKey": "null",
    "ProposalMcmsContext": {
      "key": "null"
    },
    "UpstreamErrorDetail": "null"
  },
  "Code": "INNER_ERROR",
  "Message": "A system error occurred.",
  "Advice": "Contact the administrator.",
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 100,
  "Cost": "30",
  "Data": "e_5anwndq"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.