1. 接口描述
接口请求域名: dsgc.tencentcloudapi.com 。
新建用户自建云资源
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateDSPASelfBuildMetaResource。 |
Version | 是 | String | 公共参数,本接口取值:2019-07-23。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-shanghai, ap-shanghai-fsi, ap-singapore 。 |
DspaId | 是 | String | Dspa实例ID。 示例值:dspa-a1b2c3 |
MetaType | 是 | String | 自建数据库类型。目前支持的自建数据库类型按照协议进行区分,支持两种开源数据库协议: mysql_like_proto -- Mysql协议类关系型数据库, postgre_like_proto -- Postgre协议类关系型数据库。 其他闭源协议的数据库如SqlServer、Oracle等暂不支持。 示例值:cdb |
ResourceRegion | 是 | String | 资源所处地域。 示例值:ap-guangzhou |
ResourceId | 是 | String | 自建云资源ID。 示例值:cdb-a1b2 |
ResourceUniqueVpcId | 是 | String | 自建云资源的VPC ID。 示例值:127.31.41.43 |
ResourceUniqueSubnetId | 是 | String | 自建云资源的Subnet ID。 示例值:4214 |
ResourceAccessType | 是 | String | 自建云资源所处的服务类型,可选: cvm - 通过云服务器直接访问。 clb - 通过LB的方式进行访问。 示例值:cvm |
ResourceVip | 是 | String | 可用于访问自建云资源的IP。 emr的连接不需要使用该字段 示例值:127.31.41.42 |
ResourceVPort | 是 | Integer | 可用于访问自建云资源的端口。 emr的连接不需要使用该字段 示例值:2203 |
UserName | 是 | String | 账户名。如果emr_hive的连接方式为“LDAP”,则复用该字段 示例值:admin |
Password | 是 | String | 账户密码。如果emr_hive的连接方式为“LDAP”,则复用该字段 示例值:password |
ResourceName | 否 | String | 资源名称,1-60个字符。 示例值:cdb-11am |
InstanceType | 否 | String | 实例类型 databse sid serviceName 示例值:database |
InstanceValue | 否 | String | 实例值 示例值:database |
AuthRange | 否 | String | 授权范围(all:授权整个数据源 manual:手动指定数据库) 示例值:all |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ConnectivityStatus | String | 连通性测试情况,success表示可正常访问,failed表示无法访问。 示例值:success |
ConnectivityDescription | String | 连通性描述字段,如果连通性测试失败,这里会返回无法访问的相关信息说明。 示例值:success-desc |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例
输入示例
输出示例
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
LimitExceeded | 超过配额限制。 |
ResourceNotFound | 资源不存在。 |