Creating a Data Source
Function
This API is used to create a data source.
Calling Method
For details, see Calling APIs.
URI
POST /v1.0/{project_id}/clusters/{cluster_id}/ext-data-sources
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition Project ID. To obtain the value, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A |
cluster_id |
Yes |
String |
Definition Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID. Constraints The value must be a valid DWS cluster ID. Range It is a 36-digit UUID. Default Value N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
data_source_id |
No |
String |
Definition External data source ID. This parameter is mandatory when the data source is MRS. Range N/A |
type |
Yes |
String |
Definition Data source type. Range N/A |
data_source_name |
Yes |
String |
Definition Name of the external data source. Range The value can contain 1 to 64 characters. Only uppercase letters, lowercase letters, numbers, and underscores (_) are allowed. |
user_name |
Yes |
String |
Definition Username. If the data source is OBS, set this parameter to the OBS agency name. Range The value can contain 3 to 20 characters. Only uppercase letters, lowercase letters, numbers, and underscores (_) are allowed. |
user_pwd |
No |
String |
Definition Password. This parameter is mandatory when the data source is MRS. Range N/A |
description |
No |
String |
Definition Description. Range Characters excluding <>'=& Max. 256 characters |
reboot |
No |
Boolean |
Definition Whether to restart the cluster. Range N/A |
connect_info |
No |
String |
Definition Connected database. This parameter is mandatory when the data source is OBS. Range N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition Data source ID. Range N/A |
job_id |
String |
Definition ID of the task for creating a data source. Range N/A |
Example Requests
Create an OBS data source named source1 and set the username to DWSAccessOBS, and connect it to GaussDB.
POST https://{Endpoint} /v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/ext-data-sources { "type" : "OBS", "data_source_name" : "source1", "user_name" : "DWSAccessOBS", "connect_info" : "gaussdb", "description" : "description" }
Example Responses
Status code: 200
Request submitted.
{ "id" : "d303f19c-fbd1-4716-ae04-07d1ff358f22", "job_id" : "2c9081c88418ed420184197c8bc80001" }
Status Codes
Status Code |
Description |
---|---|
200 |
Request submitted. |
400 |
Request error. |
401 |
Authentication failed. |
403 |
You do not have required permissions. |
404 |
No resources found. |
500 |
Internal server error. |
503 |
Service unavailable. |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot