文档

CreateOceanBaseDataSource - 创建 OceanBase 数据源

更新时间:

本接口用于创建 OceanBase 数据源。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
Namestring

数据源的名称。

source_name
Typestring

数据源的类型。

枚举值:
  • OB_MYSQL_VPCOB_MYSQL_VPC
  • OB_ORACLE_VPCOB_ORACLE_VPC
  • OB_ORACLE_TENANTOB_ORACLE_TENANT
  • OB_ORACLEOB_ORACLE
  • OB_MYSQLOB_MYSQL
  • OB_MYSQL_TENANTOB_MYSQL_TENANT
OB_MYSQL_VPC
Tenantstring

OceanBase 数据库租户的名称。

tenant_name
Clusterstring

OceanBase 数据库租户所在集群的名称。

cluster_name
VpcIdstring

用户申请公有云 VPC 的唯一 ID。

vpc-bp1d2q3mhg9i23ofi****
Ipstring

数据库宿主机的 IP。

xxx.xxx.xxx.1
Portinteger

数据库宿主机 IP 的端口号。

2883
LogProxyIpstring

LogProxy IP。

null
LogProxyPortstring

LogProxy 端口。

null
UserNamestring

数据库用户名。

user_name
Passwordstring

数据库用户的密码,需要使用 Base64 加密。

cGFzc193b3JK
Descriptionstring

数据源的描述信息。

test
ConfigUrlstring

用于获取 OceanBase 数据库底层服务器的真实地址。

http://xxx.xxx.xxx.2:2883/services?Action=ObRootServiceInfo&User_ID=alibaba&UID=ocpmaster&ObRegion=ob_1***29.admin
DrcUserNamestring

该用户主要用于读取 OceanBase 数据库增量日志和数据库对象结构信息,请在业务集群 sys 租户下创建该用户。

user_na***
DrcPasswordstring

sys 租户下用户名的密码(Base64 编码)。

pas***
InnerDrcPasswordstring

__oceanbase_inner_drc_user 的密码(base64 编码)。

in***

返回参数

名称类型描述示例值
object

返回结果。

Successboolean

是否调用成功。

true
ErrorDetailobject

错误详情。

Codestring

错误码(新)。

CM-RESOAT1111
Levelstring

包括 FATAL、ERROR、WARNING 和 CRITICAL。

ERROR
Messagestring

错误描述(新)。

A system error occurred.
ExtraContextobject

用于填充 Message 中的占位符。

any

用于填充 Message 中的占位符。

null
MessageMcmsKeystring

错误信息的 Key。

null
MessageMcmsContextobject

用于填充 MessageMcmsKey 中的占位符。

string

用于填充 MessageMcmsKey 中的占位符。

null
Reasonstring

错误原因。

null
ReasonMcmsKeystring

错误原因的 Key。

null
ReasonMcmsContextobject

错误原因的上下文。

string

错误原因的上下文。

null
Proposalstring

建议(新)。

null
ProposalMcmsKeystring

建议内容的 Key。

null
ProposalMcmsContextobject

建议内容的上下文。

string

建议内容的上下文。

null
UpstreamErrorDetailany

上游错误详情,用于处理 HTTP 请求。

null
Codestring

错误码(旧)。

null
Messagestring

错误描述(旧)。

A system error occurred.
Advicestring

建议(旧)。

Contact the administrator.
RequestIdstring

请求 ID。

EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
PageNumberinteger

页序号,分页查询时生效。

1
PageSizeinteger

页大小,分页查询时生效。

10
TotalCountlong

总数,分页查询时生效。

30
Coststring

请求耗时,单位为秒。

1
Datastring

OceanBase 数据源的 ID。

e_edz****

示例

正常返回示例

JSON格式

{
  "Success": true,
  "ErrorDetail": {
    "Code": "CM-RESOAT1111\n",
    "Level": "ERROR",
    "Message": "A system error occurred.\n",
    "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": "null",
  "Message": "A system error occurred.\n",
  "Advice": "Contact the administrator. ",
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 30,
  "Cost": "1",
  "Data": "e_edz****"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-05-07API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
  • 本页导读 (0)