运维安全中心 开通服务(实例相关接口)

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

相关产品
运维安全中心(堡垒机) 产品页,含版本规格、价格与购买入口。

一、1. 接口描述

开通服务,初始化资源,只针对新购资源

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

二、2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数,本接口取值:DeployResource。
Version 是 String 公共参数,本接口取值:2023-04-18。
Region 是 String 公共参数,详见产品支持的 地域列表。
ResourceId 是 String 需要开通服务的资源ID示例值:bh-saas-test
ApCode 是 String 需要开通服务的地域示例值:ap-guangzhou
Zone 是 String 子网所在可用区示例值:ap-guangzhou-3
VpcId 是 String 需要开通服务的VPC示例值:vpc-bhtest
SubnetId 是 String 需要开通服务的子网ID,此字段即将废除,请填写DeploySubnets包含的子网示例值:subnet-bhtest
CidrBlock 是 String 需要开通服务的子网网段,此字段即将废除,请填写DeploySubnets包含的子网示例值:10.10.10.0/24
VpcName 否 String 需要开通服务的VPC名称示例值:vpc1
VpcCidrBlock 否 String 需要开通服务的VPC对应的网段示例值:10.10.0.0/16
SubnetName 否 String 需要开通服务的子网名称,此字段即将废除,请填写DeploySubnets包含的子网示例值:subnet1
CdcClusterId 否 String 需要开通实例所属的CDC集群ID示例值:cdc-bhtest
ShareClbId 否 String 开通堡垒机指定共享的clbId示例值:lb-xefesef
WebAccess 否 Integer 0-关闭web访问堡垒机,1-开启web访问堡垒机示例值:1
ClientAccess 否 Integer 0-关闭客户端访问堡垒机,1-开启客户端访问堡垒机示例值:1
IntranetAccess 否 Integer 0-关闭内网访问堡垒机,1-开启内网访问堡垒机示例值:0
ExternalAccess 否 Integer 0-关闭公网访问堡垒机,1-开启公网访问堡垒机示例值:1
DeploySubnets.N 否 Array of ParamInitResourceSubnet 开通堡垒机的子网信息,最多支持2个子网
IntranetVpcId 否 String 开通内网访问的VPC ID示例值:vpc-q1of50wz
IntranetVpcCidrBlock 否 String 开通内网访问的VPC 网段示例值:192.168.0.0/16
IntranetVpcName 否 String 开通内网访问的VPC名称示例值:gordan-test1
IntranetSubnets.N 否 Array of ParamInitResourceSubnet 开通内网访问的子网信息,最多支持2个子网

三、3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

四、输入示例

POST / HTTP/1.1
Host: bh.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeployResource
<公共请求参数>
{
"ResourceId": "bh-saas-************",
"ApCode": "ap-guangzhou",
"Zone": "ap-guangzhou-6",
"VpcId": "vpc-q1of5***",
"SubnetId": "subnet-dp102ji4",
"CidrBlock": "192.168.24.0/24",
"VpcName": "gordan-test1",
"VpcCidrBlock": "192.168.0.0/16",
"SubnetName": "zone6",
"WebAccess": 1,
"ClientAccess": 1,
"IntranetAccess": 1,
"ExternalAccess": 1,
"DeploySubnets": [
{
"SubnetId": "subnet-dp102***",
"SubnetName": "zone6",
"Zone": "ap-guangzhou-6",
"SubnetCidrBlock": "192.168.24.0/24"
}
],
"IntranetVpcId": "vpc-q1of5***",
"IntranetVpcCidrBlock": "192.168.0.0/16",
"IntranetVpcName": "gordan-test1",
"IntranetSubnets": [
{
"SubnetId": "subnet-dp102***",
"SubnetName": "zone6",
"Zone": "ap-guangzhou-6",
"SubnetCidrBlock": "192.168.24.0/24"
}
]
}

五、输出示例

{
"Response": {
"RequestId": "6e4ae08b-bcca-43a2-86f3-2c3613154299"
}
}

六、腾讯云 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: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

九、命令行工具

·Tencent Cloud CLI 3.0

十、6. 错误码

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

错误码 描述
FailedOperation.VPCDeployed FailedOperation.VPCDeployed
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
OperationDenied 操作被拒绝。
ResourceNotFound 资源不存在。
ResourceUnavailable 资源不可用。
赞 (0)
上一篇 4天前
下一篇 4天前