创建业务资源

最近更新时间:2026-04-30 02:02:22

我的收藏

1. 接口描述

接口请求域名: ioa.tencentcloudapi.com 。

创建业务资源,会对一些必填参数进行校验和参数合法性校验,创建业务资源时,先调用下校验相同业务资源接口,看资源是不是有冲突。创建时也会做校验,但没有返回对应的异常信息,私有化调用path为:capi/GatewayResource/CreateBusinessResource

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateBusinessResource。
Version String 公共参数,本接口取值:2022-06-01。
Region String 公共参数,本接口不需要传递此参数。
AreaId Integer 业务资源所在的模块id,没有资源模块先创建资源模块(只支持32位)
Protocol Integer 业务资源协议类型, 1:UDP, 2:TCP, 3:所有协议(只支持32位)
ServiceName String 业务资源名称,同一个资源模块下面不可重复
ServiceType String 业务资源类型:ip,domain,ip_section,对应ip、域名、ip段
ServicePort String 业务资源端口 all,1-65535
Levels Integer 业务资源优先级 1-65535(只支持32位)
ServiceAddress String 业务资源地址(ip、域名、ip段)
DirectConn Integer 是否走代理,该参数不传,默认为0, 2:内外网直连,1:内网直连, 0:不启用代理配置(只支持32位)

3. 输出参数

参数名称 类型 描述
Data CreateBusinessResourceData 创建业务资源响应的数据
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建业务资源测试用例

测试用例

输入示例

POST / HTTP/1.1
Host: ioa.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateBusinessResource
<公共请求参数>

{
    "AreaId": 3684,
    "Protocol": 1,
    "ServiceName": "test资源",
    "ServiceType": "domain",
    "ServicePort": "8080",
    "Levels": 12312,
    "ServiceAddress": "*.12312.com",
    "DirectConn": 0
}

输出示例

{
    "Response": {
        "Data": {
            "ServiceId": 4391
        },
        "RequestId": "20a21cd8-cbc5-4d70-a14d-9c6aafcbd8ab"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError.DatabaseException 内部错误,数据库异常。
InternalError.NotZeroTrustGateway 没有零信任网关数据。
InvalidParameter.DuplicateResourcesExist 存在重复的资源数据。
InvalidParameter.DuplicateResourcesName 存在重复业务资源名称。
InvalidParameter.RequestParam 请求参数错误。
InvalidParameter.ResourceAccessMethod 业务资源访问方式错误。
InvalidParameter.ResourceDomainErr 业务资源域名不合法。
InvalidParameter.ResourceIPError 业务资源IP数据错误。
InvalidParameter.ResourceIPSegmentErr 业务资源IP段数据错误。
InvalidParameter.ResourceLevelsParameter 业务资源优先级取值范围[1-65535]。
InvalidParameter.ResourcePortErr 业务资源端口错误。
InvalidParameter.ResourceProtocolTypeErr 业务资源协议类型错误。
InvalidParameter.ResourceTypeParameter 业务资源类型错误。
ResourceNotFound.NoModuleData 没有模块数据。
UnauthorizedOperation.NoModulePermissions 没有模块权限。