Managed Service for Greenplum® API, REST: PXFDatasource.create
Creates PXF datasource
HTTP request
POST https://mdb.api.cloud.yandex.net/managed-greenplum/v1/clusters/{clusterId}/pxf_datasources
Path parameters
Parameter | Description |
---|---|
clusterId | Required. The maximum string length in characters is 50. |
Body parameters
{
"datasource": {
"name": "string",
// `datasource` includes only one of the fields `s3`, `jdbc`, `hdfs`, `hive`
"s3": {
"accessKey": "string",
"secretKey": "string",
"fastUpload": true,
"endpoint": "string"
},
"jdbc": {
"driver": "string",
"url": "string",
"user": "string",
"password": "string",
"statementBatchSize": "integer",
"statementFetchSize": "integer",
"statementQueryTimeout": "integer",
"poolEnabled": true,
"poolMaximumSize": "integer",
"poolConnectionTimeout": "integer",
"poolIdleTimeout": "integer",
"poolMinimumIdle": "integer"
},
"hdfs": {
"core": {
"defaultFs": "string",
"securityAuthToLocal": "string"
},
"kerberos": {
"enable": true,
"primary": "string",
"realm": "string",
"kdcServers": [
"string"
],
"adminServer": "string",
"defaultDomain": "string",
"keytabBase64": "string"
},
"userImpersonation": true,
"username": "string",
"saslConnectionRetries": "integer",
"zkHosts": [
"string"
],
"dfs": {
"haAutomaticFailoverEnabled": true,
"blockAccessTokenEnabled": true,
"useDatanodeHostname": true,
"namenodes": "object"
},
"yarn": {
"resourcemanagerHaEnabled": true,
"resourcemanagerHaAutoFailoverEnabled": true,
"resourcemanagerHaAutoFailoverEmbedded": true,
"resourcemanagerClusterId": "string",
"haRm": "object"
}
},
"hive": {
"core": {
"defaultFs": "string",
"securityAuthToLocal": "string"
},
"kerberos": {
"enable": true,
"primary": "string",
"realm": "string",
"kdcServers": [
"string"
],
"adminServer": "string",
"defaultDomain": "string",
"keytabBase64": "string"
},
"userImpersonation": true,
"username": "string",
"saslConnectionRetries": "integer",
"zkHosts": [
"string"
],
"ppd": true,
"metastoreUris": [
"string"
],
"metastoreKerberosPrincipal": "string",
"authKerberosPrincipal": "string"
},
// end of the list of possible fields`datasource`
}
}
Field | Description |
---|---|
datasource | object |
datasource. name |
string Required. The string length in characters must be 3-200. |
datasource. s3 |
object datasource includes only one of the fields s3 , jdbc , hdfs , hive |
datasource. s3. accessKey |
string The maximum string length in characters is 200. |
datasource. s3. secretKey |
string The maximum string length in characters is 200. |
datasource. s3. fastUpload |
boolean (boolean) |
datasource. s3. endpoint |
string The maximum string length in characters is 200. |
datasource. jdbc |
object datasource includes only one of the fields s3 , jdbc , hdfs , hive |
datasource. jdbc. driver |
string Matches jdbc.driver The maximum string length in characters is 50. |
datasource. jdbc. url |
string Matches jdbc.url The maximum string length in characters is 200. |
datasource. jdbc. user |
string Matches jdbc.user The maximum string length in characters is 200. |
datasource. jdbc. password |
string Matches jdbc.password The maximum string length in characters is 200. |
datasource. jdbc. statementBatchSize |
integer (int64) Matches jdbc.statement.batchsize Acceptable values are 50 to 1000, inclusive. |
datasource. jdbc. statementFetchSize |
integer (int64) Matches jdbc.statement.fetchsize Acceptable values are 50 to 10000, inclusive. |
datasource. jdbc. statementQueryTimeout |
integer (int64) Matches jdbc.statement.querytimeout Acceptable values are 5 to 600, inclusive. |
datasource. jdbc. poolEnabled |
boolean (boolean) Matches jdbc.pool.enabled |
datasource. jdbc. poolMaximumSize |
integer (int64) Matches jdbc.pool.property.maximumpoolsize Acceptable values are 10 to 200, inclusive. |
datasource. jdbc. poolConnectionTimeout |
integer (int64) Matches jdbc.pool.property.connectiontimeout Acceptable values are 5000 to 600000, inclusive. |
datasource. jdbc. poolIdleTimeout |
integer (int64) Matches jdbc.pool.property.idletimeout Acceptable values are 5000 to 600000, inclusive. |
datasource. jdbc. poolMinimumIdle |
integer (int64) Matches jdbc.pool.property.minimumidle Acceptable values are 0 to 200, inclusive. |
datasource. hdfs |
object datasource includes only one of the fields s3 , jdbc , hdfs , hive |
datasource. hdfs. core |
object |
datasource. hdfs. core. defaultFs |
string The maximum string length in characters is 200. |
datasource. hdfs. core. securityAuthToLocal |
string The maximum string length in characters is 1000. |
datasource. hdfs. kerberos |
object |
datasource. hdfs. kerberos. enable |
boolean (boolean) |
datasource. hdfs. kerberos. primary |
string The maximum string length in characters is 128. |
datasource. hdfs. kerberos. realm |
string The maximum string length in characters is 1000. |
datasource. hdfs. kerberos. kdcServers[] |
string The maximum number of elements is 200. The string length in characters for each value must be 1-200. |
datasource. hdfs. kerberos. adminServer |
string The maximum string length in characters is 128. |
datasource. hdfs. kerberos. defaultDomain |
string The maximum string length in characters is 128. |
datasource. hdfs. kerberos. keytabBase64 |
string The maximum string length in characters is 65536. Value must match the regular expression |
datasource. hdfs. userImpersonation |
boolean (boolean) |
datasource. hdfs. username |
string The maximum string length in characters is 128. |
datasource. hdfs. saslConnectionRetries |
integer (int64) Acceptable values are 1 to 50, inclusive. |
datasource. hdfs. zkHosts[] |
string The maximum number of elements is 200. The string length in characters for each value must be 1-200. |
datasource. hdfs. dfs |
object |
datasource. hdfs. dfs. haAutomaticFailoverEnabled |
boolean (boolean) |
datasource. hdfs. dfs. blockAccessTokenEnabled |
boolean (boolean) |
datasource. hdfs. dfs. useDatanodeHostname |
boolean (boolean) |
datasource. hdfs. dfs. namenodes |
object No more than 10000 per resource. |
datasource. hdfs. yarn |
object |
datasource. hdfs. yarn. resourcemanagerHaEnabled |
boolean (boolean) |
datasource. hdfs. yarn. resourcemanagerHaAutoFailoverEnabled |
boolean (boolean) |
datasource. hdfs. yarn. resourcemanagerHaAutoFailoverEmbedded |
boolean (boolean) |
datasource. hdfs. yarn. resourcemanagerClusterId |
string The maximum string length in characters is 1000. |
datasource. hdfs. yarn. haRm |
object No more than 10000 per resource. |
datasource. hive |
object datasource includes only one of the fields s3 , jdbc , hdfs , hive |
datasource. hive. core |
object |
datasource. hive. core. defaultFs |
string The maximum string length in characters is 200. |
datasource. hive. core. securityAuthToLocal |
string The maximum string length in characters is 1000. |
datasource. hive. kerberos |
object |
datasource. hive. kerberos. enable |
boolean (boolean) |
datasource. hive. kerberos. primary |
string The maximum string length in characters is 128. |
datasource. hive. kerberos. realm |
string The maximum string length in characters is 1000. |
datasource. hive. kerberos. kdcServers[] |
string The maximum number of elements is 200. The string length in characters for each value must be 1-200. |
datasource. hive. kerberos. adminServer |
string The maximum string length in characters is 128. |
datasource. hive. kerberos. defaultDomain |
string The maximum string length in characters is 128. |
datasource. hive. kerberos. keytabBase64 |
string The maximum string length in characters is 65536. Value must match the regular expression |
datasource. hive. userImpersonation |
boolean (boolean) |
datasource. hive. username |
string The maximum string length in characters is 128. |
datasource. hive. saslConnectionRetries |
integer (int64) Acceptable values are 1 to 50, inclusive. |
datasource. hive. zkHosts[] |
string The maximum number of elements is 200. The string length in characters for each value must be 1-200. |
datasource. hive. ppd |
boolean (boolean) |
datasource. hive. metastoreUris[] |
string The maximum number of elements is 200. The string length in characters for each value must be 1-200. |
datasource. hive. metastoreKerberosPrincipal |
string The maximum string length in characters is 1000. |
datasource. hive. authKerberosPrincipal |
string The maximum string length in characters is 1000. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": true,
"metadata": "object",
// includes only one of the fields `error`, `response`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
},
"response": "object",
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
createdAt | string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
createdBy | string ID of the user or service account who initiated the operation. |
modifiedAt | string (date-time) The time when the Operation resource was last modified. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
done | boolean (boolean) If the value is |
metadata | object Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
error | object The error result of the operation in case of failure or cancellation. includes only one of the fields error , response |
error. code |
integer (int32) Error code. An enum value of google.rpc.Code. |
error. message |
string An error message. |
error. details[] |
object A list of messages that carry the error details. |
response | object includes only one of the fields error , response The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any. |