CLI命令参考
专享版-API分组管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 创建API分组 | hcloud APIG CreateApiGroupV2 | API分组是API的管理单元，一个API分组等同于一个服务入口，创建API分组时，返回一个子域名作为访问入口。建议一个API分组下的API具有一定的相关性。 | |
| 查询分组列表 | hcloud APIG ListApiGroupsV2 | 查询API分组列表。 | |
| 查询分组详情 | hcloud APIG ShowDetailsOfApiGroupV2 | 查询指定分组的详细信息。 | |
| 删除API分组 | hcloud APIG DeleteApiGroupV2 | 删除指定的API分组。 | |
| 修改API分组 | hcloud APIG UpdateApiGroupV2 | 修改API分组属性。其中name和remark可修改，其他属性不可修改。 | |
| 校验API分组名称是否存在 | hcloud APIG CheckApiGroupsV2 | 校验API分组名称是否存在。 |
专享版-环境管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 创建环境 | hcloud APIG CreateEnvironmentV2 | 在实际的生产中，API提供者可能有多个环境，如开发环境、测试环境、生产环境等，用户可以自由将API发布到某个环境，供调用者调用。 | |
| 查询环境列表 | hcloud APIG ListEnvironmentsV2 | 查询符合条件的环境列表。 | |
| 删除环境 | hcloud APIG DeleteEnvironmentV2 | 删除指定的环境。 | |
| 修改环境 | hcloud APIG UpdateEnvironmentV2 | 修改指定环境的信息。其中可修改的属性为：name、remark，其它属性不可修改。 |
专享版-环境变量管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 新建变量 | hcloud APIG CreateEnvironmentVariableV2 | 将API发布到不同的环境后，对于不同的环境，可能会有不同的环境变量，比如，API的服务部署地址，请求的版本号等。 | |
| 查询变量列表 | hcloud APIG ListEnvironmentVariablesV2 | 查询分组下的所有环境变量的列表。 | |
| 查询变量详情 | hcloud APIG ShowDetailsOfEnvironmentVariableV2 | 查询指定的环境变量的详情。 | |
| 删除变量 | hcloud APIG DeleteEnvironmentVariableV2 | 删除指定的环境变量。 | |
| 修改变量 | hcloud APIG UpdateEnvironmentVariableV2 | 修改环境变量。环境变量引用位置为api的后端服务地址时，修改对应环境变量会将使用该变量的所有api重新发布。 |
专享版-流控策略管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询流控策略详情 | hcloud APIG ShowDetailsOfRequestThrottlingPolicyV2 | 查询指定流控策略的详细信息。 | |
| 删除流控策略 | hcloud APIG DeleteRequestThrottlingPolicyV2 | 删除指定的流控策略，以及该流控策略与API的所有绑定关系。 | |
| 修改流控策略 | hcloud APIG UpdateRequestThrottlingPolicyV2 | 修改指定流控策略的详细信息。 | |
| 创建流控策略 | hcloud APIG CreateRequestThrottlingPolicyV2 | 当API上线后，系统会默认给每个API提供一个流控策略，API提供者可以根据自身API的服务能力及负载情况变更这个流控策略。 | |
| 查询流控策略列表 | hcloud APIG ListRequestThrottlingPolicyV2 | 查询所有流控策略的信息。 |
专享版-API管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 创建API | hcloud APIG CreateApiV2 | 添加一个API，API即一个服务接口，具体的服务能力。 | |
| 查询API列表 | hcloud APIG ListApisV2 | 查询API列表，返回API详细信息、发布信息等，但不能查询到后端服务信息和API请求参数信息 | |
| 查询API详情 | hcloud APIG ShowDetailsOfApiV2 | 查询指定的API的详细信息。 | |
| 删除API | hcloud APIG DeleteApiV2 | 删除指定的API。 | |
| 修改API | hcloud APIG UpdateApiV2 | 修改指定API的信息，包括后端服务信息。 | |
| 校验API定义 | hcloud APIG CheckApisV2 | 校验API定义。校验API的路径或名称是否已存在 | |
| 发布或下线API | hcloud APIG CreateOrDeletePublishRecordForApiV2 | 对API进行发布或下线。 | |
| 调试API | hcloud APIG DebugApiV2 | 调试一个API在指定运行环境下的定义，接口调用者需要具有操作该API的权限。 | |
| 批量发布或下线API | hcloud APIG BatchPublishOrOfflineApiV2 | 将多个API发布到一个指定的环境，或将多个API从指定的环境下线。 | |
| 查询API历史版本列表 | hcloud APIG ListApiVersionsV2 | 查询某个API的历史版本。每个API在一个环境上最多存在10个历史版本。 | |
| 切换API版本 | hcloud APIG ChangeApiVersionV2 | API每次发布时，会基于当前的API定义生成一个版本。版本记录了API发布时的各种定义及状态。 | |
| 查询API运行时定义 | hcloud APIG ListApiRuntimeDefinitionV2 | 查询指定的API在指定的环境上的运行时定义，默认查询RELEASE环境上的运行时定义。 | |
| 查询版本详情 | hcloud APIG ListApiVersionDetailV2 | 查询某个指定的版本详情。 | |
| 根据版本编号下线API | hcloud APIG DeleteApiByVersionIdV2 | 对某个生效中的API版本进行下线操作，下线后，API在该版本生效的环境中将不再能够被调用。 |
专享版-签名密钥管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 创建签名密钥 | hcloud APIG CreateSignatureKeyV2 | 为了保护API的安全性，建议租户为API的访问提供一套保护机制，即租户开放的API，需要对请求来源进行认证，不符合认证的请求直接拒绝访问。 | |
| 查询签名密钥列表 | hcloud APIG ListSignatureKeysV2 | 查询所有签名密钥的信息。 | |
| 删除签名密钥 | hcloud APIG DeleteSignatureKeyV2 | 删除指定的签名密钥，删除签名密钥时，其配置的绑定关系会一并删除，相应的签名密钥会失效。 | |
| 修改签名密钥 | hcloud APIG UpdateSignatureKeyV2 | 修改指定签名密钥的详细信息。 |
专享版-签名密钥绑定关系管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 绑定签名密钥 | hcloud APIG AssociateSignatureKeyV2 | 签名密钥创建后，需要绑定到API才能生效。 | |
| 解除API与签名密钥的绑定关系 | hcloud APIG DisassociateSignatureKeyV2 | 解除API与签名密钥的绑定关系。 | |
| 查询API绑定的签名密钥列表 | hcloud APIG ListSignatureKeysBindedToApiV2 | 查询某个API绑定的签名密钥列表。每个API在每个环境上应该最多只会绑定一个签名密钥。 | |
| 查询签名密钥未绑定的API列表 | hcloud APIG ListApisNotBoundWithSignatureKeyV2 | 查询所有未绑定到该签名密钥上的API列表。需要API已经发布，未发布的API不予展示。 | |
| 查询签名密钥绑定的API列表 | hcloud APIG ListApisBindedToSignatureKeyV2 | 查询某个签名密钥上已经绑定的API列表。 |
专享版-API绑定流控策略
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 绑定流控策略 | hcloud APIG AssociateRequestThrottlingPolicyV2 | 将流控策略应用于API，则所有对该API的访问将会受到该流控策略的限制。 | |
| 批量解绑流控策略 | hcloud APIG BatchDisassociateThrottlingPolicyV2 | 批量解除API与流控策略的绑定关系 | |
| 解除API与流控策略的绑定关系 | hcloud APIG DisassociateRequestThrottlingPolicyV2 | 解除API与流控策略的绑定关系。 | |
| 查询流控策略绑定的API列表 | hcloud APIG ListApisBindedToRequestThrottlingPolicyV2 | 查询某个流控策略上已经绑定的API列表。 | |
| 查询流控策略未绑定的API列表 | hcloud APIG ListApisUnbindedToRequestThrottlingPolicyV2 | 查询所有未绑定到该流控策略上的自有API列表。需要API已经发布，未发布的API不予展示。 | |
| 查询API绑定的流控策略列表 | hcloud APIG ListRequestThrottlingPoliciesBindedToApiV2 | 查询某个API绑定的流控策略列表。每个环境上应该最多只有一个流控策略。 |
专享版-设置特殊流控
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 创建特殊设置 | hcloud APIG CreateSpecialThrottlingConfigurationV2 | 流控策略可以限制一段时间内可以访问API的最大次数，也可以限制一段时间内单个租户和单个APP可以访问API的最大次数。 | |
| 查询特殊设置列表 | hcloud APIG ListSpecialThrottlingConfigurationsV2 | 查询给流控策略设置的特殊配置。 | |
| 删除特殊设置 | hcloud APIG DeleteSpecialThrottlingConfigurationV2 | 删除某个流控策略的某个特殊配置。 | |
| 修改特殊设置 | hcloud APIG UpdateSpecialThrottlingConfigurationV2 | 修改某个流控策略下的某个特殊设置。 |
专享版-APP授权管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| APP授权 | hcloud APIG CreateAuthorizingAppsV2 | APP创建成功后，还不能访问API，如果想要访问某个环境上的API，需要将该API在该环境上授权给APP。授权成功后，APP即可访问该环境上的这个API。 | |
| 解除授权 | hcloud APIG CancelingAuthorizationV2 | 解除API对APP的授权关系。解除授权后，APP将不再能够调用该API。 | |
| 查询API已绑定的APP列表 | hcloud APIG ListAppsBindedToApiV2 | 查询API绑定的APP列表。 | |
| 查询APP已绑定的API列表 | hcloud APIG ListApisBindedToAppV2 | 查询APP已经绑定的API列表。 | |
| 查询APP未绑定的API列表 | hcloud APIG ListApisUnbindedToAppV2 | 查询指定环境上某个APP未绑定的API列表，包括自有API和从云商店购买的API。 |
专享版-概要查询
专享版-域名管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 绑定域名 | hcloud APIG AssociateDomainV2 | 用户自定义的域名，需要增加A记录才能生效，具体方法请参见《云解析服务用户指南》的“添加A类型记录集”章节。 | |
| 修改域名 | hcloud APIG UpdateDomainV2 | 修改绑定的域名所对应的配置信息。使用实例自定义入方向端口的特性时，注意开启/关闭客户端校验会对相同域名的不同端口同时生效。 | |
| 解绑域名 | hcloud APIG DisassociateDomainV2 | 如果API分组不再需要绑定某个自定义域名，则可以为此API分组解绑此域名。 | |
| 设置调试域名是否可以访问 | hcloud APIG UpdateSlDomainSettingV2 | 禁用或启用API分组绑定的调试域名 | |
| 绑定域名证书 | hcloud APIG AssociateCertificateV2 | 如果创建API时，“定义API请求”使用HTTPS请求协议，那么在独立域名中需要添加SSL证书。 | |
| 删除域名证书 | hcloud APIG DisassociateCertificateV2 | 如果域名证书不再需要或者已过期，则可以删除证书内容。在使用自定义入方向端口的特性时，相同的域名会同时解绑证书。 | |
| 查询域名证书 | hcloud APIG ShowDetailsOfDomainNameCertificateV2 | 查询域名下绑定的证书详情。 |
专享版-ACL策略管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询ACL策略列表 | hcloud APIG ListAclStrategiesV2 | 查询所有的ACL策略列表。 | |
| 批量删除ACL策略 | hcloud APIG BatchDeleteAclV2 | 批量删除指定的多个ACL策略。 | |
| 创建ACL策略 | hcloud APIG CreateAclStrategyV2 | 增加一个ACL策略，策略类型通过字段acl_type来确定（permit或者deny），限制的对象的类型可以为IP或者DOMAIN，这里的DOMAIN对应的acl_value的值为租户名称，而非“www.exampleDomain.com”之类的网络域名。 | |
| 查询ACL策略详情 | hcloud APIG ShowDetailsOfAclPolicyV2 | 查询指定ACL策略的详情。 | |
| 修改ACL策略 | hcloud APIG UpdateAclStrategyV2 | 修改指定的ACL策略，其中可修改的属性为：acl_name、acl_type、acl_value，其它属性不可修改。 | |
| 删除ACL策略 | hcloud APIG DeleteAclV2 | 删除指定的ACL策略，如果存在API与该ACL策略的绑定关系，则无法删除。 |
专享版-API绑定ACL策略
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 批量解除API与ACL策略的绑定 | hcloud APIG BatchDeleteApiAclBindingV2 | 批量解除API与ACL策略的绑定 | |
| 将API与ACL策略进行绑定 | hcloud APIG CreateApiAclBindingV2 | 将API与ACL策略进行绑定。 | |
| 解除API与ACL策略的绑定 | hcloud APIG DeleteApiAclBindingV2 | 解除某条API与ACL策略的绑定关系 | |
| 查询API绑定的ACL策略列表 | hcloud APIG ListAclPolicyBindedToApiV2 | 查询API绑定的ACL策略列表 | |
| 查询ACL策略绑定的API列表 | hcloud APIG ListApisBindedToAclPolicyV2 | 查询ACL策略绑定的API列表 | |
| 查询ACL策略未绑定的API列表 | hcloud APIG ListApisUnbindedToAclPolicyV2 | 查询ACL策略未绑定的API列表，需要API已发布 |
专享版-自定义认证管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询自定义认证列表 | hcloud APIG ListCustomAuthorizersV2 | 查询自定义认证列表 | |
| 创建自定义认证 | hcloud APIG CreateCustomAuthorizerV2 | 创建自定义认证 | |
| 查询自定义认证详情 | hcloud APIG ShowDetailsOfCustomAuthorizersV2 | 查询自定义认证详情 | |
| 修改自定义认证 | hcloud APIG UpdateCustomAuthorizerV2 | 修改自定义认证 | |
| 删除自定义认证 | hcloud APIG DeleteCustomAuthorizerV2 | 删除自定义认证 |
专享版-OpenAPI接口
专享版-VPC通道管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 创建VPC通道 | hcloud APIG CreateVpcChannelV2 | 在API网关中创建连接私有VPC资源的通道，并在创建API时将后端节点配置为使用这些VPC通道，以便API网关直接访问私有VPC资源。 | |
| 查询VPC通道列表 | hcloud APIG ListVpcChannelsV2 | 查询VPC通道列表 | |
| 查询VPC通道详情 | hcloud APIG ShowDetailsOfVpcChannelV2 | 查询指定的VPC通道详情 | |
| 删除VPC通道 | hcloud APIG DeleteVpcChannelV2 | 删除指定的VPC通道 | |
| 更新VPC通道 | hcloud APIG UpdateVpcChannelV2 | 更新指定VPC通道的参数 | |
| 修改VPC通道健康检查 | hcloud APIG UpdateHealthCheck | 修改VPC通道健康检查。 | |
| 添加或更新后端实例 | hcloud APIG AddingBackendInstancesV2 | 为指定的VPC通道添加后端实例 | |
| 查询后端实例列表 | hcloud APIG ListBackendInstancesV2 | 查询指定VPC通道的后端实例列表。 | |
| 更新后端实例 | hcloud APIG UpdateBackendInstancesV2 | 更新指定的VPC通道的后端实例。更新时，使用传入的请求参数对对应云服务组的后端实例进行全量覆盖修改。如果未指定修改的云服务器组，则进行全量覆盖。 | |
| 删除后端实例 | hcloud APIG DeleteBackendInstanceV2 | 删除指定VPC通道中的后端实例 | |
| 批量修改后端服务器状态可用 | hcloud APIG BatchEnableMembers | 批量修改后端服务器状态可用。 | |
| 批量修改后端服务器状态不可用 | hcloud APIG BatchDisableMembers | 批量修改后端服务器状态不可用。 | |
| 添加或更新VPC通道后端服务器组 | hcloud APIG CreateMemberGroup | 在APIG中创建VPC通道后端服务器组，VPC通道后端实例可以选择是否关联后端实例服务器组，以便管理后端服务器节点。 | |
| 查询VPC通道后端云服务组列表 | hcloud APIG ListMemberGroups | 查询VPC通道后端云服务组列表 | |
| 查询VPC通道后端服务器组详情 | hcloud APIG ShowDetailsOfMemberGroup | 查询指定的VPC通道后端服务器组详情 | |
| 删除VPC通道后端服务器组 | hcloud APIG DeleteMemberGroup | 删除指定的VPC通道后端服务器组 | |
| 更新VPC通道后端服务器组 | hcloud APIG UpdateMemberGroup | 更新指定VPC通道后端服务器组。当负载通道为nacos微服务类型时，不支持修改服务器组权重。 |
专享版-监控信息查询
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| API统计信息查询-最近一段时间 | hcloud APIG ListLatelyApiStatisticsV2 | 根据API的id和最近的一段时间查询API被调用的次数，统计周期为1分钟。查询范围一小时以内，一分钟一个样本，其样本值为一分钟内的累计值。 | |
| 分组统计信息查询-最近一小时内 | hcloud APIG ListLatelyGroupStatisticsV2 | 根据API分组的编号查询该分组下所有API被调用的总次数，统计周期为1分钟。查询范围一小时以内，一分钟一个样本，其样本值为一分钟内的累计值。 | |
| 查询监控数据 | hcloud APIG ListMetricData | 查询指定时间范围指定指标的指定粒度的监控数据，可以通过参数指定需要查询的数据维度。 |
专享版-分组自定义响应管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 创建分组自定义响应 | hcloud APIG CreateGatewayResponseV2 | 新增分组下自定义响应 | |
| 查询分组自定义响应列表 | hcloud APIG ListGatewayResponsesV2 | 查询分组自定义响应列表 | |
| 查询分组自定义响应详情 | hcloud APIG ShowDetailsOfGatewayResponseV2 | 查询分组自定义响应详情 | |
| 修改分组自定义响应 | hcloud APIG UpdateGatewayResponseV2 | 修改分组自定义响应 | |
| 删除分组自定义响应 | hcloud APIG DeleteGatewayResponseV2 | 删除分组自定义响应 | |
| 查询分组下指定错误类型的自定义响应 | hcloud APIG ShowDetailsOfGatewayResponseTypeV2 | 查询分组下指定错误类型的自定义响应 | |
| 修改分组下指定错误类型的自定义响应 | hcloud APIG UpdateGatewayResponseTypeV2 | 修改分组下指定错误类型的自定义响应。 | |
| 删除分组指定错误类型的自定义响应配置 | hcloud APIG DeleteGatewayResponseTypeV2 | 删除分组指定错误类型的自定义响应配置，还原为使用默认值的配置。 |
专享版-标签管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询API的标签列表 | hcloud APIG ListTagsV2 | 查询API的标签列表。 |
专享版-实例特性管理
专享版-配置管理
专享版-实例管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 创建专享版实例（按需） | hcloud APIG CreateInstanceV2 | 创建按需专享版实例 | |
| 查询专享版实例列表 | hcloud APIG ListInstancesV2 | 查询专享版实例列表 | |
| 查询专享版实例详情 | hcloud APIG ShowDetailsOfInstanceV2 | 查询专享版实例详情 | |
| 删除专享版实例 | hcloud APIG DeleteInstancesV2 | 删除专享版实例 | |
| 更新专享版实例 | hcloud APIG UpdateInstanceV2 | 更新专享版实例 | |
| 查询专享版实例创建进度 | hcloud APIG ShowDetailsOfInstanceProgressV2 | 查询专享版实例创建进度 | |
| 实例更新或绑定EIP | hcloud APIG AddEipV2 | 实例更新或绑定EIP（仅当实例为LVS类型时支持） | |
| 实例解绑EIP | hcloud APIG RemoveEipV2 | 实例解绑EIP | |
| 开启实例公网出口 | hcloud APIG AddEngressEipV2 | 实例开启公网出口 | |
| 更新实例出公网带宽 | hcloud APIG UpdateEngressEipV2 | 更新实例出公网带宽 | |
| 关闭实例公网出口 | hcloud APIG RemoveEngressEipV2 | 关闭实例公网出口 | |
| 开启实例公网入口 | hcloud APIG AddIngressEipV2 | 开启实例公网入口，仅当实例为ELB类型时支持 | |
| 更新实例入公网带宽 | hcloud APIG UpdateIngressEipV2 | 更新实例入公网带宽，仅当实例为ELB类型时支持 | |
| 关闭实例公网入口 | hcloud APIG RemoveIngressEipV2 | 关闭实例公网入口，仅当实例为ELB类型时支持 | |
| 查询可用区信息 | hcloud APIG ListAvailableZonesV2 | 查询可用区信息 | |
| 创建专享版实例（包周期） | hcloud APIG CreateOrder | 创建包周期专享版实例。 | |
| 创建包周期规格变更订单 | hcloud APIG CreatePrepayResize | 创建包周期规格变更订单。 | |
| 按需规格变更 | hcloud APIG CreatePostPayResizeOrder | 创建按需规格变更订单。 | |
| 查询实例约束信息 | hcloud APIG ShowRestrictionOfInstanceV2 | 查询实例约束信息 |
专享版-实例终端节点管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询实例终端节点连接列表 | hcloud APIG ListEndpointConnections | 查询实例终端节点连接列表。 | |
| 接受或拒绝终端节点连接 | hcloud APIG AcceptOrRejectEndpointConnections | 接受或拒绝实例节点连接。 | |
| 查询实例的终端节点服务的白名单列表 | hcloud APIG ListEndpointPermissions | 查询当前实例终端节点服务的白名单列表。 | |
| 批量添加实例终端节点连接白名单 | hcloud APIG AddEndpointPermissions | 批量添加实例终端节点连接白名单。 | |
| 批量删除实例终端节点连接白名单 | hcloud APIG DeleteEndpointPermissions | 批量删除实例终端节点连接白名单。 |
专享版-实例标签管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询项目下所有实例标签 | hcloud APIG ListProjectInstanceTags | 查询项目下所有实例标签。 | |
| 查询单个实例标签 | hcloud APIG ListInstanceTags | 查询单个实例的标签。 | |
| 批量添加或删除单个实例的标签 | hcloud APIG BatchCreateOrDeleteInstanceTags | 批量添加或删除单个实例的标签。 | |
| 查询包含指定标签的实例数量 | hcloud APIG ShowInstancesNumByTags | 查询包含指定标签的实例数量。 | |
| 通过标签查询实例列表 | hcloud APIG ListInstancesByTags | 通过标签查询实例列表 |
专享版-微服务中心管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 导入微服务 | hcloud APIG ImportMicroservice | 导入微服务。 |
专享版-SSL证书管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 获取SSL证书列表 | hcloud APIG ListCertificatesV2 | 获取SSL证书列表。 | |
| 创建SSL证书 | hcloud APIG CreateCertificateV2 | 创建SSL证书。 | |
| 域名绑定SSL证书 | hcloud APIG BatchAssociateCertsV2 | 域名绑定SSL证书。目前暂时仅支持单个绑定，请求体当中的certificate_ids里面有且只能有一个证书ID。使用实例自定义入方向端口的特性时，相同的域名会同时绑定证书，注意开启/关闭客户端校验会对相同域名的不同端口同时生效。 | |
| 域名解绑SSL证书 | hcloud APIG BatchDisassociateCertsV2 | 域名解绑SSL证书。目前暂时仅支持单个解绑，请求体当中的certificate_ids里面有且只能有一个证书ID。在使用自定义入方向端口的特性时，相同的域名会同时解绑证书。 | |
| 查询证书详情 | hcloud APIG ShowDetailsOfCertificateV2 | 查询证书详情。 | |
| 删除SSL证书 | hcloud APIG DeleteCertificateV2 | 删除SSL证书接口，删除时只有没有关联域名的证书才能被删除。 | |
| 修改SSL证书 | hcloud APIG UpdateCertificateV2 | 修改SSL证书。 | |
| SSL证书绑定域名 | hcloud APIG BatchAssociateDomainsV2 | SSL证书绑定域名。使用实例自定义入方向端口的特性时，相同的域名会同时绑定证书，注意开启/关闭客户端校验会对相同域名的不同端口同时生效。 | |
| SSL证书解绑域名 | hcloud APIG BatchDisassociateDomainsV2 | SSL证书解绑域名。在使用自定义入方向端口的特性时，相同的域名会同时解绑证书。 | |
| 获取SSL证书已绑定域名列表 | hcloud APIG ListAttachedDomainsV2 | 获取SSL证书已绑定域名列表。 |
专享版-插件管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 创建插件 | hcloud APIG CreatePlugin | 创建插件信息。 | |
| 查询插件列表 | hcloud APIG ListPlugins | 查询一组符合条件的API网关插件详情。 | |
| 修改插件 | hcloud APIG UpdatePlugin | 修改插件信息。 | |
| 删除插件 | hcloud APIG DeletePlugin | 删除插件。 | |
| 查询插件详情 | hcloud APIG ShowPlugin | 查询插件详情。 | |
| 插件绑定API | hcloud APIG AttachApiToPlugin | 绑定插件到API上。 | |
| 解除绑定插件的API | hcloud APIG DetachApiFromPlugin | 解除绑定在插件上的API。 | |
| 查询插件下绑定的API | hcloud APIG ListPluginAttachedApis | 查询指定插件下绑定的API信息。 | |
| 查询可绑定当前插件的API | hcloud APIG ListPluginAttachableApis | 查询可绑定当前插件的API信息。 | |
| API绑定插件 | hcloud APIG AttachPluginToApi | 绑定插件到API上。 | |
| 解除绑定API的插件 | hcloud APIG DetachPluginFromApi | 解除绑定在API上的插件。 | |
| 查询API下绑定的插件 | hcloud APIG ListApiAttachedPlugins | 查询指定API下绑定的插件信息。 | |
| 查询可绑定当前API的插件 | hcloud APIG ListApiAttachablePlugins | 查询可绑定当前API的插件信息。 |
专享版-凭据管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 创建APP | hcloud APIG CreateAnAppV2 | APP即应用，是一个可以访问API的身份标识。将API授权给APP后，APP即可调用API。 | |
| 查询APP列表 | hcloud APIG ListAppsV2 | 查询APP列表。 | |
| 查询APP详情 | hcloud APIG ShowDetailsOfAppV2 | 查询指定APP的详细信息。 | |
| 删除APP | hcloud APIG DeleteAppV2 | 删除指定的APP。 | |
| 修改APP | hcloud APIG UpdateAppV2 | 修改指定APP的信息。其中可修改的属性为：name、remark、related_domain_id、related_project_id，当支持用户自定义key和secret的开关开启时，app_key和app_secret也支持修改，其它属性不可修改。 | |
| 重置密钥 | hcloud APIG ResettingAppSecretV2 | 重置指定APP的密钥。 | |
| 校验APP | hcloud APIG CheckAppV2 | 校验APP是否存在，非APP所有者可以调用该接口校验APP是否真实存在。该接口只展示APP的基本信息id、name。 | |
| 创建APP Code | hcloud APIG CreateAppCodeV2 | APP Code为APP应用下的子模块，创建APP Code之后，可以实现简易的APP认证。 | |
| 自动生成APP Code | hcloud APIG CreateAppCodeAutoV2 | 创建App Code时，可以不指定具体值，由后台自动生成随机字符串填充。 | |
| 查询APP Code列表 | hcloud APIG ListAppCodesV2 | 查询APP Code列表。 | |
| 查询APP Code详情 | hcloud APIG ShowDetailsOfAppCodeV2 | APP Code为APP应用下的子模块，创建APP Code之后，可以实现简易的APP认证。 | |
| 删除APP Code | hcloud APIG DeleteAppCodeV2 | 删除APP Code，APP Code删除后，将无法再通过简易认证访问对应的API。 | |
| 查询凭据关联的凭据配额 | hcloud APIG ShowAppBoundAppQuota | 查询指定凭据关联的凭据配额。 | |
| 设置APP的访问控制 | hcloud APIG UpdateAppAcl | 设置凭据的访问控制。 | |
| 查询APP的访问控制详情 | hcloud APIG ShowDetailsOfAppAcl | 查询APP的访问控制详情。 | |
| 删除APP的访问控制 | hcloud APIG DeleteAppAcl | 删除凭据的访问控制信息。 | |
| 创建AIAPIKey | hcloud APIG CreateAiApiKey | 创建AIAPIKey，适用于AI场景下的API Key认证。 | |
| 查询AIAPIKey列表 | hcloud APIG ListAiApiKeys | 查询AIAPIKey列表。 | |
| 查看AIAPIKey详情 | hcloud APIG ShowDetailsOfAiApiKey | 查看AIAPIKey详情。 | |
| 删除AIAPIKey | hcloud APIG DeleteAiApiKey | 删除AIAPIKey。删除后，将无法使用该AIAPIKey进行认证。 |
专享版-凭据配额管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 获取凭据配额列表 | hcloud APIG ListAppQuotas | 获取凭据配额列表。支持根据名称模糊查询 | |
| 创建凭据配额 | hcloud APIG CreateAppQuota | 创建凭据配额 | |
| 获取凭据配额详情 | hcloud APIG ShowAppQuota | 获取凭据配额详情 | |
| 修改凭据配额 | hcloud APIG UpdateAppQuota | 修改凭据配额 | |
| 删除凭据配额 | hcloud APIG DeleteAppQuota | 删除凭据配额。删除凭据配额时，同时删除凭据配额和凭据的关联关系 | |
| 查询凭据配额已绑定的凭据列表 | hcloud APIG ListAppQuotaBoundApps | 查询凭据配额已绑定的凭据列表。支持按凭据名称模糊匹配 | |
| 凭据配额绑定凭据列表 | hcloud APIG AssociateAppsForAppQuota | 凭据配额绑定凭据列表 | |
| 解除凭据配额和凭据的绑定 | hcloud APIG DisassociateAppQuotaWithApp | 解除凭据配额和凭据的绑定 | |
| 查询凭据配额可绑定的凭据列表 | hcloud APIG ListAppQuotaBindableApps | 查询凭据配额可绑定的凭据列表。支持按凭据名称模糊搜索 |
专享版-异步任务管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 异步导出API | hcloud APIG ExportApiDefinitionsAsync | 导出分组下API的定义信息。导出文件内容符合swagger标准规范，API网关自定义扩展字段请参考《API网关用户指南》的“导入导出API：扩展定义”章节。 | |
| 异步导入API | hcloud APIG ImportApiDefinitionsAsync | 导入API。导入文件内容需要符合swagger标准规范，API网关自定义扩展字段请参考《API网关用户指南》的“导入导出API：扩展定义”章节。 | |
| 获取异步任务结果 | hcloud APIG ShowAsyncTaskResult | 获取异步任务结果。 |
专享版-编排规则管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 创建编排规则 | hcloud APIG CreateOrchestration | 创建编排规则 | |
| 查询编排规则列表 | hcloud APIG ListOrchestrations | 查询编排规则列表 | |
| 查询编排规则详情 | hcloud APIG ShowDetailsOfOrchestration | 查询编排规则详情 | |
| 更新编排规则 | hcloud APIG UpdateOrchestration | 更新编排规则 | |
| 删除编排规则 | hcloud APIG DeleteOrchestration | 删除编排规则 | |
| 查询编排规则绑定的API | hcloud APIG ListOrchestrationAttachedApis | 查询编排规则下绑定的API信息 |
专享版-实例自定义入方向端口管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询实例指定的自定义入方向端口绑定的域名信息 | hcloud APIG ListCustomIngressPortDomains | 查询实例指定的自定义入方向端口绑定的域名信息。 | |
| 查询实例的自定义入方向端口列表 | hcloud APIG ListCustomIngressPorts | 查询实例的自定义入方向端口列表。 | |
| 新增实例的自定义入方向端口 | hcloud APIG AddCustomIngressPort | 新增实例的自定义入方向端口，在同个实例中，一个端口仅能支持一种协议。 | |
| 删除实例指定的自定义入方向端口 | hcloud APIG DeleteCustomIngressPort | 删除实例指定的自定义入方向端口，不包含默认端口80和443。 |
共享版-API分组管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 创建API分组 | hcloud APIG CreateApiGroup | API分组是API的管理单元，一个API分组等同于一个服务入口，创建API分组时，返回一个子域名作为访问入口。建议一个API分组下的API具有一定的相关性。 | |
| 查询分组列表 | hcloud APIG ListApiGroups | 查询API分组列表。 | |
| 查询分组详情 | hcloud APIG ShowDetailsOfApiGroup | 查询指定分组的详细信息。 | |
| 删除API分组 | hcloud APIG DeleteApiGroup | 删除指定的API分组。 | |
| 修改API分组 | hcloud APIG UpdateAPIGroup | 修改API分组属性。其中name和remark可修改，其他属性不可修改。 |
共享版-环境管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 创建环境 | hcloud APIG CreateEnvironment | 在实际的生产中，API提供者可能有多个环境，如开发环境、测试环境、生产环境等，用户可以自由将API发布到某个环境，供调用者调用。对于不同的环境，API的版本、请求地址甚至于包括请求消息等均有可能不同。如：某个API，v1.0的版本为稳定版本，发布到了生产环境供生产使用，同时，该API正处于迭代中，v1.1的版本是开发人员交付测试人员进行测试的版本，发布在测试环境上，而v1.2的版本目前开发团队正处于开发过程中，可以发布到开发环境进行自测等。 | |
| 查询环境列表 | hcloud APIG ListEnvironments | 查询符合条件的环境列表。 | |
| 删除环境 | hcloud APIG DeleteEnvironment | 删除指定的环境。 | |
| 修改环境 | hcloud APIG UpdateEnvironment | 修改指定环境的信息。其中可修改的属性为：name、remark，其它属性不可修改。 |
共享版-环境变量管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 新建变量 | hcloud APIG CreateEnvironmentVariable | 将API发布到不同的环境后，对于不同的环境，可能会有不同的环境变量，比如，API的服务部署地址，请求的版本号等。 | |
| 查询变量列表 | hcloud APIG ListEnvironmentVariables | 查询分组下的所有环境变量的列表。 | |
| 查看变量详情 | hcloud APIG ShowEnvironmentVariableDetails | 查看指定的环境变量的详情。 | |
| 删除变量 | hcloud APIG DeleteEnvironmentVariable | 删除指定的环境变量。 |
共享版-流控策略管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查看流控策略详情 | hcloud APIG ShowDetailsOfARequestThrottlingPolicy | 查看指定流控策略的详细信息。 | |
| 删除流控策略 | hcloud APIG DeleteRequestThrottlingPolicy | 删除指定的流控策略，以及该流控策略与API的所有绑定关系。 | |
| 修改流控策略 | hcloud APIG UpdateRequestThrottlingPolicy | 修改指定流控策略的详细信息。 | |
| 创建流控策略 | hcloud APIG CreateRequestThrottlingPolicy | 当API上线后，系统会默认给每个API提供一个流控策略，API提供者可以根据自身API的服务能力及负载情况变更这个流控策略。 流控策略即限制API在一定长度的时间内，能够允许被访问的最大次数。 | |
| 查询流控策略列表 | hcloud APIG ListTheRequestThrottlingPolicy | 查询所有流控策略的信息。 |
共享版-API管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 注册API | hcloud APIG CreateApi | 添加一个API，API即一个服务接口，具体的服务能力。API分为两部分，第一部分为面向API使用者的API接口，定义了使用者如何调用这个API。第二部分面向API提供者，由API提供者定义这个API的真实的后端情况，定义了API网关如何去访问真实的后端服务。API的真实后端服务目前支持三种类型：传统的HTTP/HTTPS形式的web后端、函数工作流、MOCK。 | |
| 查询API列表 | hcloud APIG ListApis | 查看API列表，返回API详细信息、发布信息等，但不能查看到后端服务信息。 | |
| 查询API详情 | hcloud APIG ShowDetailsOfApi | 查看指定的API的详细信息。 | |
| 删除API | hcloud APIG DeleteApi | 删除指定的API。删除API时，会删除该API所有相关的资源信息或绑定关系，如API的发布记录，绑定的后端服务，对APP的授权信息等。 | |
| 修改API | hcloud APIG UpdateApi | 修改指定API的信息，包括后端服务信息。 |
共享版-签名密钥管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 创建签名密钥 | hcloud APIG CreateSignatureKey | 为了保护API的安全性，建议租户为API的访问提供一套保护机制，即租户开放的API，需要对请求来源进行认证，不符合认证的请求直接拒绝访问。 其中，签名密钥就是API安全保护机制的一种。 租户创建一个签名密钥，并将签名密钥与API进行绑定，则API网关在请求这个API时，就会使用绑定的签名密钥对请求参数进行数据加密，生成签名。当租户的后端服务收到请求时，可以校验这个签名，如果签名校验不通过，则该请求不是API网关发出的请求，租户可以拒绝这个请求，从而保证API的安全性，避免API被未知来源的请求攻击。 | |
| 查询签名密钥列表 | hcloud APIG ListSignatureKeys | 查询所有签名密钥的信息。 | |
| 删除签名密钥 | hcloud APIG DeleteSignatureKey | 删除指定的签名密钥，删除签名密钥时，其配置的绑定关系会一并删除，相应的签名密钥会失效。 | |
| 修改签名密钥 | hcloud APIG UpdateSignatureKey | 修改指定签名密钥的详细信息。 |
共享版-签名密钥绑定关系管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 绑定签名密钥 | hcloud APIG AssociateSignatureKey | 签名密钥创建后，需要绑定到API才能生效。将签名密钥绑定到API后，则API网关请求后端服务时就会使用这个签名密钥进行加密签名，后端服务可以校验这个签名来验证请求来源。 将指定的签名密钥绑定到一个或多个已发布的API上。 同一个API发布到不同的环境可以绑定不同的签名密钥；一个API在发布到特定环境后只能绑定一个签名密钥。 | |
| 查看签名密钥未绑定的API列表 | hcloud APIG ListApisNotBoundWithSignatureKey | 查询所有未绑定到该签名密钥上的API列表。需要API已经发布，未发布的API不予展示。 | |
| 查看API绑定的签名密钥列表 | hcloud APIG ListSignatureKeysBoundtoAnAPI | 查询某个API绑定的签名密钥列表。每个API在每个环境上应该最多只会绑定一个签名密钥。 | |
| 解除绑定 | hcloud APIG DisassociateSignatureKey | 解除API与签名密钥的绑定关系。 | |
| 查看签名密钥绑定的API列表 | hcloud APIG ListApisBoundWithSignatureKey | 查询某个签名密钥上已经绑定的API列表。 |
共享版-API绑定流控策略
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 解除API与流控策略的绑定关系 | hcloud APIG DisassociateRequestThrottlingPolicy | 解除API与流控策略的绑定关系。 | |
| 查看API绑定的流控策略列表 | hcloud APIG ListRequestThrottlingPoliciesThatBoundToAnApi | 查询某个API绑定的流控策略列表。每个环境上应该最多只有一个流控策略。 | |
| 查看流控策略绑定的API列表 | hcloud APIG ListApisThatBoundWithRequestThrottlingPolicy | 查询某个流控策略上已经绑定的API列表。 | |
| 查看流控策略未绑定的API列表 | hcloud APIG ListApisThatNotBoundWithRequestThrottlingPolicy | 查询所有未绑定到该流控策略上的自有API列表。需要API已经发布，未发布的API不予展示。 | |
| 绑定流控策略 | hcloud APIG AssociateRequestThrottlingPolicy | 将流控策略应用于API，则所有对该API的访问将会受到该流控策略的限制。当一定时间内的访问次数超过流控策略设置的API最大访问次数限制后，后续的访问将会被拒绝，从而能够较好的保护后端API免受异常流量的冲击，保障服务的稳定运行。为指定的共享版-API绑定流控策略，绑定时，需要指定在哪个环境上生效。同一个API发布到不同的环境可以绑定不同的流控策略；一个API在发布到特定环境后只能绑定一个默认的流控策略。 |
共享版-设置特殊流控
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查看特殊设置列表 | hcloud APIG ListSpecialThrottlingConfigurations | 查看给流控策略设置的特殊配置。 | |
| 删除特殊设置 | hcloud APIG DeleteSpecialThrottlingConfiguration | 删除某个流控策略的某个特殊配置。 | |
| 修改特殊设置 | hcloud APIG UpdateSpecialThrottlingConfiguration | 修改某个流控策略下的某个特殊设置。 | |
| 创建特殊设置 | hcloud APIG CreateSpecialThrottlingConfiguration | 流控策略可以限制一段时间内可以访问API的最大次数，也可以限制一段时间内单个租户和单个APP可以访问API的最大次数。 如果想要对某个特定的APP进行特殊设置，例如设置所有APP每分钟的访问次数为500次，但想设置APP1每分钟的访问次数为800次，可以通过在流控策略中设置特殊APP来实现该功能。 为流控策略添加一个特殊设置的对象，可以是APP，也可以是租户。 |
共享版-APP授权管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| APP授权 | hcloud APIG CreateAuthorizingApps | APP创建成功后，还不能访问API，如果想要访问某个环境上的API，需要将该API在该环境上授权给APP。授权成功后，APP即可访问该环境上的这个API。 | |
| 解除授权 | hcloud APIG CancelingAuthorization | 解除API对APP的授权关系。解除授权后，APP将不再能够调用该API。 | |
| 查看API已绑定的APP列表 | hcloud APIG ListAppsBoundToAnApi | 查询API绑定的APP列表。 | |
| 查看APP已绑定的API列表 | hcloud APIG ListAPIsThatBoundWithAnApp | 查询APP已经绑定的API列表。 | |
| 查看APP未绑定的API列表 | hcloud APIG ListApisThatNotBoundWithAnApp | 查询指定环境上某个APP未绑定的API列表，包括自有API和从云商店购买的API。 |
共享版-概要查询
共享版-APP管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 创建APP | hcloud APIG CreateAnApp | APP即应用，是一个可以访问API的身份标识。将API授权给APP后，APP即可调用API。 | |
| 查询APP列表 | hcloud APIG ListApps | 查询APP列表。 | |
| 查看APP详情 | hcloud APIG ShowAppDetails | 查看指定APP的详细信息。 | |
| 删除APP | hcloud APIG DeleteAnApp | 删除指定的APP。 | |
| 修改APP | hcloud APIG UpdateAnApp | 修改指定APP的信息。其中可修改的属性为：name、remark，当支持用户自定义key和secret的开关开启时，app_key和app_secret也支持修改，其它属性不可修改。 | |
| 重置密钥 | hcloud APIG ResettingTheAppSecret | 重置指定APP的密钥。 | |
| 校验APP | hcloud APIG CheckAnApp | 校验APP是否存在，非APP所有者可以调用该接口校验APP是否真实存在。这个接口只展示APP的基本信息id、name、remark，其他信息不显示。 |
共享版-域名管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 绑定域名 | hcloud APIG AssociateDomain | 用户自定义的域名，需要CNAME到API分组的子域名上才能生效，具体方法请参见增加CNAME类型记录集。 | |
| 解绑域名 | hcloud APIG DisassociateDomain | 如果API分组不再需要绑定某个自定义域名，则可以为此API分组解绑此域名。 | |
| 绑定域名证书 | hcloud APIG AssociateCertificate | 如果创建API时，“定义API请求”使用HTTPS请求协议，那么在独立域名中需要添加SSL证书。 | |
| 删除域名证书 | hcloud APIG DisassociateCertificate | 如果域名证书不再需要或者已过期，则可以删除证书内容。 | |
| 查看域名证书 | hcloud APIG ShowDetailsOfDomainNameCertificate | 查看域名下绑定的证书详情。 |
