CLI Command Reference

Creating an API Group

hcloud APIG CreateApiGroupV2

This API is used to create an API group. An API group is an API management unit and the entry to a service. A subdomain name is returned as the access entry when an API group is created. APIs in an API group should be correlated with each other.

Go debug

Querying API Groups

hcloud APIG ListApiGroupsV2

This API is used to query the API group list.

Go debug

Querying API Group Details

hcloud APIG ShowDetailsOfApiGroupV2

This API is used to query the details of an API group.

Go debug

Deleting an API Group

hcloud APIG DeleteApiGroupV2

This API is used to delete an API group.

Go debug

Modifying an API Group

hcloud APIG UpdateApiGroupV2

This API is used to modify the attributes of an API group. Only the name and remark attributes of an API group can be modified.

Go debug

Verifying an API Group Name

hcloud APIG CheckApiGroupsV2

This API is used to check whether the API group name exists.

Go debug

Creating an Environment

hcloud APIG CreateEnvironmentV2

API providers can publish an API in different environments, such as the development, test, and production environments.

Go debug

Querying Environments

hcloud APIG ListEnvironmentsV2

This API is used to query environments.

Go debug

Deleting an Environment

hcloud APIG DeleteEnvironmentV2

This API is used to delete an environment.

Go debug

Modifying an Environment

hcloud APIG UpdateEnvironmentV2

This API is used to modify the information about an environment. Only the name and remark attributes of an environment can be modified.

Go debug

Creating a Variable

hcloud APIG CreateEnvironmentVariableV2

Publishing an API in different environments may involve various variables, such as API service deployment address and request version.

Go debug

Querying Environment Variables

hcloud APIG ListEnvironmentVariablesV2

This API is used to query all environment variables under an API group.

Go debug

Querying Variable Details

hcloud APIG ShowDetailsOfEnvironmentVariableV2

This API is used to query the details of an environment variable.

Go debug

Deleting a Variable

hcloud APIG DeleteEnvironmentVariableV2

This API is used to delete an environment variable.

Go debug

Modifying a Variable

hcloud APIG UpdateEnvironmentVariableV2

This API is used to modify an environment variable. If an environment variable is referenced by the backend service address of an API, modifying the environment variable will publish all APIs that use the variable again.

Go debug

Querying Details of a Request Throttling Policy

hcloud APIG ShowDetailsOfRequestThrottlingPolicyV2

This API is used to query the details of a request throttling policy.

Go debug

Deleting a Request Throttling Policy

hcloud APIG DeleteRequestThrottlingPolicyV2

This API is used to delete a request throttling policy and all binding relationships between the policy and APIs.

Go debug

Modifying a Request Throttling Policy

hcloud APIG UpdateRequestThrottlingPolicyV2

This API is used to modify the information about a request throttling policy.

Go debug

Creating a Request Throttling Policy

hcloud APIG CreateRequestThrottlingPolicyV2

After an API goes online, the system attaches a request throttling policy to it by default. The API provider can change the request throttling policy based on the service capabilities and load of the API.

Go debug

Querying Request Throttling Policies

hcloud APIG ListRequestThrottlingPolicyV2

This API is used to query all the request throttling policies.

Go debug

Creating an API

hcloud APIG CreateApiV2

This API is used to create an API. An API is an interface that encapsulates a set of service capabilities.

Go debug

Querying APIs

hcloud APIG ListApisV2

This API is used to query APIs and return their details and publication information. Backend information and request parameters of the APIs will not be returned.

Go debug

Querying API Details

hcloud APIG ShowDetailsOfApiV2

This API is used to query the details of an API.

Go debug

Deleting an API

hcloud APIG DeleteApiV2

This API is used to delete an API.

Go debug

Modifying an API

hcloud APIG UpdateApiV2

This API is used to modify the information about an API, including its backend information.

Go debug

Verifying the API Definition

hcloud APIG CheckApisV2

This API is used to verify the API definition, that is, whether the API path or name already exists.

Go debug

Publishing an API or Taking an API Offline

hcloud APIG CreateOrDeletePublishRecordForApiV2

This API is used to publish an API or take an API offline.

Go debug

Debugging an API

hcloud APIG DebugApiV2

This API is used to debug an API in a specified environment. The API caller must have the permissions required for accessing this API.

Go debug

Publishing APIs or Taking APIs Offline

hcloud APIG BatchPublishOrOfflineApiV2

This API is used to publish multiple APIs in an environment or to remove multiple APIs from the environment in which they have been published.

Go debug

Querying Historical Versions of an API

hcloud APIG ListApiVersionsV2

This API is used to query the historical versions of an API. APIG retains a maximum of 10 historical versions for each API in an environment.

Go debug

Switching the Version of an API

hcloud APIG ChangeApiVersionV2

This API is used to switch the version of an API. A version is generated based on the current definition of an API when the API is published. The version records the definition and status of the API when it is published.

Go debug

Querying the Runtime Definition of an API

hcloud APIG ListApiRuntimeDefinitionV2

This API is used to query the runtime definition of an API in a specified environment. The runtime definition of an API in the RELEASE environment is queried if no environment is specified.

Go debug

Querying API Version Details

hcloud APIG ListApiVersionDetailV2

This API is used to query the details of a specified API version.

Go debug

Taking an API Version Offline

hcloud APIG DeleteApiByVersionIdV2

This API is used to remove an effective version of an API. The removed API cannot be called in the environment in which it took effect.

Go debug

Creating a Signature Key

hcloud APIG CreateSignatureKeyV2

It is a good practice to provide a protection mechanism for APIs to ensure access security. For example, authenticating API request sources and denying the access from unauthorized sources.

Go debug

Querying Signature Keys

hcloud APIG ListSignatureKeysV2

This API is used to query all the signature keys.

Go debug

Deleting a Signature Key

hcloud APIG DeleteSignatureKeyV2

This API is used to delete a signature key. This operation will invalidate the signature key and unbind it from the APIs to which it was bound.

Go debug

Modifying a Signature Key

hcloud APIG UpdateSignatureKeyV2

This API is used to modify the information about a signature key.

Go debug

Binding a Signature Key

hcloud APIG AssociateSignatureKeyV2

A signature key takes effect only after being bound to an API.

Go debug

Unbinding a Signature Key

hcloud APIG DisassociateSignatureKeyV2

This API is used to unbind a signature key from an API.

Go debug

Querying Signature Keys Bound to an API

hcloud APIG ListSignatureKeysBindedToApiV2

This API is used to query the signature keys that have been bound to a specified API. Only one signature key can be bound to an API in an environment.

Go debug

Querying APIs Not Bound with a Signature Key

hcloud APIG ListApisNotBoundWithSignatureKeyV2

This API is used to query the APIs to which a signature key has not been bound. Only published APIs will be displayed.

Go debug

Querying APIs Bound with a Signature Key

hcloud APIG ListApisBindedToSignatureKeyV2

This API is used to query the APIs to which a signature key has been bound.

Go debug

Binding a Request Throttling Policy

hcloud APIG AssociateRequestThrottlingPolicyV2

The request throttling policy bound to an API will control access of all users to the API.

Go debug

Unbinding Request Throttling Policies

hcloud APIG BatchDisassociateThrottlingPolicyV2

This API is used to unbind request throttling policies from APIs.

Go debug

Unbinding a Request Throttling Policy

hcloud APIG DisassociateRequestThrottlingPolicyV2

This API is used to unbind a request throttling policy from an API.

Go debug

Querying APIs Bound with a Request Throttling Policy

hcloud APIG ListApisBindedToRequestThrottlingPolicyV2

This API is used to query the APIs to which a specified request throttling policy has been bound.

Go debug

Querying the APIs Not Bound with a Request Throttling Policy

hcloud APIG ListApisUnbindedToRequestThrottlingPolicyV2

This API is used to query the self-developed APIs to which a request throttling policy has not been bound. Only published APIs will be displayed.

Go debug

Querying Request Throttling Policies Bound to an API

hcloud APIG ListRequestThrottlingPoliciesBindedToApiV2

This API is used to query the request throttling policies that have been bound to an API. Only one request throttling policy can be bound to an API in an environment.

Go debug

Creating an Excluded Request Throttling Configuration

hcloud APIG CreateSpecialThrottlingConfigurationV2

A request throttling policy controls the maximum number of times an API can be accessed within a specified period and the maximum numbers of times the API can be accessed by a tenant or an app within the same period.

Go debug

Querying Excluded Request Throttling Configurations

hcloud APIG ListSpecialThrottlingConfigurationsV2

This API is used to query all excluded configurations of a request throttling policy.

Go debug

Deleting an Excluded Request Throttling Configuration

hcloud APIG DeleteSpecialThrottlingConfigurationV2

This API is used to delete an excluded configuration of a request throttling policy.

Go debug

Modifying an Excluded Request Throttling Configuration

hcloud APIG UpdateSpecialThrottlingConfigurationV2

This API is used to modify an excluded configuration of a request throttling policy.

Go debug

Authorizing Apps

hcloud APIG CreateAuthorizingAppsV2

An app cannot access any APIs after being created. To access an API in a specific environment, bind the app to the API in the environment.

Go debug

Canceling Authorization

hcloud APIG CancelingAuthorizationV2

This API is used to cancel the authorization of an app for accessing an API. After this operation, the app can no longer call the API.

Go debug

Querying Apps Bound to an API

hcloud APIG ListAppsBindedToApiV2

This API is used to query the apps that have been bound to a specified API.

Go debug

Querying APIs Bound with an App

hcloud APIG ListApisBindedToAppV2

This API is used to query the APIs to which a specified app has been bound.

Go debug

Querying APIs Not Bound with an App

hcloud APIG ListApisUnbindedToAppV2

This API is used to query the self-developed APIs to which an app has not been bound in a specified environment.

Go debug

Querying API Quantities

hcloud APIG ListApiQuantitiesV2

This API is used to query the number of APIs that have been published in the RELEASE environment and the number of APIs that have not been published in this environment.

Go debug

Querying App Quantities

hcloud APIG ListAppQuantitiesV2

This API is used to query the number of apps that have been authorized to access APIs and the number of apps that have not been authorized to access any APIs.

Go debug

Querying API Group Quantities

hcloud APIG ListApiGroupsQuantitiesV2

This API is used to query the number of API groups that have been listed on KooGallery and the number of API groups that have not been listed.

Go debug

Binding a Domain Name

hcloud APIG AssociateDomainV2

A user-defined domain name takes effect only after an A record set has been added. For details, see section "Adding an A Record Set" in the Domain Name Service User Guide.

Go debug

Modifying a Domain Name

hcloud APIG UpdateDomainV2

This API is used to modify the configuration of a domain name bound to an API group. For gateways with custom inbound ports, enabling or disabling client verification takes effect for different ports of the same domain name.

Go debug

Unbinding a Domain Name

hcloud APIG DisassociateDomainV2

This API is used to unbind a custom domain name from an API group.

Go debug

Setting Accessibility of a Debugging Domain Name

hcloud APIG UpdateSlDomainSettingV2

This API is used to disable or enable the debugging domain name bound to an API group.

Go debug

Adding a Certificate to a Domain Name

hcloud APIG AssociateCertificateV2

When you create an API to be accessed through HTTPS, you must add an SSL certificate to the independent domain name that has been bound to the group the API belongs to.

Go debug

Deleting the Certificate Bound to a Domain Name

hcloud APIG DisassociateCertificateV2

This API is used to delete a certificate that is no longer needed or has expired. For gateways with custom inbound ports, the same domain name will be unbound from the certificate at the same time.

Go debug

Querying Details of a Certificate Bound to a Domain Name

hcloud APIG ShowDetailsOfDomainNameCertificateV2

This API is used to query the details of the certificate bound to a domain name.

Go debug

Querying Access Control Policies

hcloud APIG ListAclStrategiesV2

This API is used to query all the access control policies.

Go debug

Deleting Multiple Access Control Policies

hcloud APIG BatchDeleteAclV2

This API is used to delete multiple access control policies.

Go debug

Creating an Access Control Policy

hcloud APIG CreateAclStrategyV2

This API is used to create an access control policy to allow or deny API access from certain IP addresses or tenants. The acl_value value of a domain is a tenant name rather than a domain name (such as www.exampleDomain.com).

Go debug

Querying Details of an Access Control Policy

hcloud APIG ShowDetailsOfAclPolicyV2

This API is used to query the details of an access control policy.

Go debug

Modifying an Access Control Policy

hcloud APIG UpdateAclStrategyV2

This API is used to modify an access control policy. Only attributes acl_name, acl_type, and acl_value can be modified.

Go debug

Deleting an Access Control Policy

hcloud APIG DeleteAclV2

This API is used to delete an access control policy. Access control policies bound to APIs cannot be deleted.

Go debug

Unbinding Access Control Policies

hcloud APIG BatchDeleteApiAclBindingV2

This API is used to unbind multiple access control policies from APIs.

Go debug

Binding an Access Control Policy to an API

hcloud APIG CreateApiAclBindingV2

This API is used to bind an access control policy to a specified API.

Go debug

Unbinding an Access Control Policy

hcloud APIG DeleteApiAclBindingV2

This API is used to unbind an access control policy from an API.

Go debug

Querying Access Control Policies Bound to an API

hcloud APIG ListAclPolicyBindedToApiV2

This API is used to query the access control policies that have been bound to a specified API.

Go debug

Querying APIs Bound to an Access Control Policy

hcloud APIG ListApisBindedToAclPolicyV2

This API is used to query the list of APIs bound to a specified access control policy.

Go debug

Querying APIs Not Bound to an Access Control Policy

hcloud APIG ListApisUnbindedToAclPolicyV2

This API is used to query the published APIs to which an access control policy has not been bound.

Go debug

Querying Custom Authorizers

hcloud APIG ListCustomAuthorizersV2

This API is used to query all the custom authorizers under a gateway.

Go debug

Creating a Custom Authorizer

hcloud APIG CreateCustomAuthorizerV2

This API is used to create a custom authorizer.

Go debug

Querying Custom Authorizer Details

hcloud APIG ShowDetailsOfCustomAuthorizersV2

This API is used to query the details of a custom authorizer.

Go debug

Modifying a Custom Authorizer

hcloud APIG UpdateCustomAuthorizerV2

This API is used to modify a custom authorizer.

Go debug

Deleting a Custom Authorizer

hcloud APIG DeleteCustomAuthorizerV2

This API is used to delete a custom authorizer.

Go debug

Exporting APIs

hcloud APIG ExportApiDefinitionsV2

This API is used to export APIs in a specified API group. The content of the exported file complies with the Swagger standard. For details about the custom extended fields of APIG, see section "Importing and Exporting APIs" > "Extended Definition" in the API Gateway User Guide.

Go debug

Importing APIs

hcloud APIG ImportApiDefinitionsV2

This API is used to import APIs. The content of the imported file must comply with the Swagger standard. For details about the custom extended fields of APIG, see section "Importing and Exporting APIs" > "Extended Definition" in the API Gateway User Guide.

Go debug

Creating a VPC Channel

hcloud APIG CreateVpcChannelV2

This API is used to create a VPC channel from APIG to your private VPC resources. Afterwards, when creating an API, you can configure your backend service to use this VPC channel so that APIG can directly access your private VPC resources.

Go debug

Querying VPC Channels

hcloud APIG ListVpcChannelsV2

This API is used to query the VPC channels under a gateway.

Go debug

Querying VPC Channel Details

hcloud APIG ShowDetailsOfVpcChannelV2

This API is used to query the details of a VPC channel.

Go debug

Deleting a VPC Channel

hcloud APIG DeleteVpcChannelV2

This API is used to delete a VPC channel.

Go debug

Updating a VPC Channel

hcloud APIG UpdateVpcChannelV2

This API is used to update parameters of a specified VPC channel.

Go debug

Modifying VPC Channel Health Check

hcloud APIG UpdateHealthCheck

This API is used to modify the health check configuration of a VPC channel.

Go debug

Adding or Updating Backend Instances

hcloud APIG AddingBackendInstancesV2

This API is used to add backend instances to a VPC channel.

Go debug

Querying Backend Servers of a VPC Channel

hcloud APIG ListBackendInstancesV2

This API is used to query the backend instances of a specified VPC channel.

Go debug

Updating Backend Instances

hcloud APIG UpdateBackendInstancesV2

This API is used to update the backend instances of a specified VPC channel. During the update, the request parameters overwrite the backend instances of the corresponding cloud server group. If no cloud server group is specified, all cloud server groups are overwritten.

Go debug

Removing a Backend Server

hcloud APIG DeleteBackendInstanceV2

This API is used to delete a backend instance from a specified VPC channel.

Go debug

Enabling Backend Servers

hcloud APIG BatchEnableMembers

This API is used to enable backend servers of a VPC channel.

Go debug

Disabling Backend Servers

hcloud APIG BatchDisableMembers

This API is used to disable backend servers of a VPC channel.

Go debug

Adding or Updating a Backend Server Group of a VPC Channel

hcloud APIG CreateMemberGroup

When creating a backend server group for a VPC channel, you can determine whether to associate backend instances with the group to facilitate backend server node management.

Go debug

Querying Backend Server Groups of a VPC Channel

hcloud APIG ListMemberGroups

This API is used to query backend server groups of a VPC channel.

Go debug

Querying a Backend Server Group of a VPC Channel

hcloud APIG ShowDetailsOfMemberGroup

This API is used to query a backend server group of a specified VPC channel.

Go debug

Deleting a Backend Server Group of a VPC Channel

hcloud APIG DeleteMemberGroup

This API is used to delete a backend server group of a specified VPC channel.

Go debug

Updating a Backend Server Group of a VPC Channel

hcloud APIG UpdateMemberGroup

This API is used to update a backend server group of a VPC channel. If the load balance channel is the Nacos microservice, the server group weight cannot be modified.

Go debug

Querying API Calls Within a Period

hcloud APIG ListLatelyApiStatisticsV2

This API is used to query the number of times APIs in an API group are called within a period. The query is based on 1 minute. If the time range is within one hour, the server returns the number of API calls made every minute.

Go debug

Querying API Calls Under an API Group in the Last One Hour

hcloud APIG ListLatelyGroupStatisticsV2

This API is used to query the total number of times all APIs in an API group are called based on the API group ID. The query is based on 1 minute. If the time range is within one hour, the server returns the number of API calls made every minute.

Go debug

Querying Monitoring Data

hcloud APIG ListMetricData

This API is used to query the monitoring metric data at a specified granularity in a specified period of time.

Go debug

Creating a Group Response

hcloud APIG CreateGatewayResponseV2

This API is used to create a response for an API group.

Go debug

Querying Group Responses

hcloud APIG ListGatewayResponsesV2

This API is used to query the responses of an API group.

Go debug

Querying Group Response Details

hcloud APIG ShowDetailsOfGatewayResponseV2

This API is used to query the details of a response defined for an API group.

Go debug

Modifying a Group Response

hcloud APIG UpdateGatewayResponseV2

This API is used to modify a response of an API group.

Go debug

Deleting a Group Response

hcloud APIG DeleteGatewayResponseV2

This API is used to delete a group response of an API group.

Go debug

Querying the Response of an Error Type

hcloud APIG ShowDetailsOfGatewayResponseTypeV2

This API is used to query the response of an error type defined for an API group.

Go debug

Modifying the Response of an Error Type

hcloud APIG UpdateGatewayResponseTypeV2

This API is used to modify the response of an error type defined for an API group.

Go debug

Deleting the Response of an Error Type

hcloud APIG DeleteGatewayResponseTypeV2

This API is used to delete the response of an error type defined for an API group. After the response is deleted, the default response of the error type is used.

Go debug

Querying API Tags

hcloud APIG ListTagsV2

This API is used to query tags of an API.

Go debug

Configuring a Feature for a Gateway

hcloud APIG CreateFeatureV2

This API is used to configure a feature for a gateway.

Go debug

Querying Gateway Features

hcloud APIG ListFeaturesV2

This API is used to query the features of a gateway. If a gateway does not support the features listed in the following table, contact technical support to upgrade the gateway.

Go debug

Querying the Supported Features of a Gateway

hcloud APIG ListInstanceFeatures

This API is used to query the supported features of a gateway.

Go debug

Querying Resource Configurations of a Gateway

hcloud APIG ListProjectCofigsV2

This API is used to query the resource configurations and usage of a gateway.

Go debug

Querying Gateway Configurations

hcloud APIG ListInstanceConfigsV2

This API is used to query the gateway configurations.

Go debug

Creating a Dedicated Gateway (Pay-Per-Use)

hcloud APIG CreateInstanceV2

This API is used to create a pay-per-use dedicated gateway.

Go debug

Querying Dedicated Gateways

hcloud APIG ListInstancesV2

This API is used to query dedicated gateways.

Go debug

Querying Dedicated Gateway Details

hcloud APIG ShowDetailsOfInstanceV2

This API is used to query the details of a dedicated gateway.

Go debug

Deleting a Dedicated Gateway

hcloud APIG DeleteInstancesV2

This API is used to delete a dedicated gateway.

Go debug

Updating a Dedicated Gateway

hcloud APIG UpdateInstanceV2

This API is used to update a dedicated gateway.

Go debug

Querying the Creation Progress of a Dedicated Gateway

hcloud APIG ShowDetailsOfInstanceProgressV2

This API is used to query the creation progress of a dedicated gateway.

Go debug

Updating or Binding an EIP to a Dedicated Gateway

hcloud APIG AddEipV2

This API is used to bind an EIP to a dedicated gateway or update the EIP bound to a dedicated gateway (only available for LVS gateways).

Go debug

Unbinding the EIP of a Dedicated Gateway

hcloud APIG RemoveEipV2

This API is used to unbind the EIP of a dedicated gateway.

Go debug

Enabling Public Access for a Dedicated Gateway

hcloud APIG AddEngressEipV2

This API is used to enable public access for a dedicated gateway.

Go debug

Updating the Outbound Access Bandwidth of a Dedicated Gateway

hcloud APIG UpdateEngressEipV2

This API is used to update the outbound access bandwidth of a dedicated gateway.

Go debug

Disabling Public Access for a Dedicated Gateway

hcloud APIG RemoveEngressEipV2

This API is used to disable public access for a dedicated gateway.

Go debug

Enabling Public Inbound Access

hcloud APIG AddIngressEipV2

This API is used to enable public inbound access for a gateway that uses ELB for load balancing.

Go debug

Updating Public Inbound Access Bandwidth of a Gateway

hcloud APIG UpdateIngressEipV2

This API is used to update the public inbound access bandwidth of a gateway that uses ELB for load balancing.

Go debug

Disabling Public Inbound Access for a Gateway

hcloud APIG RemoveIngressEipV2

This API is used to disable public inbound access for a gateway that uses ELB for load balancing.

Go debug

Querying AZs

hcloud APIG ListAvailableZonesV2

This API is used to query AZs.

Go debug

Modifying the Specifications of a Pay-Per-Use Gateway

hcloud APIG CreatePostPayResizeOrder

This API is used to create a specification change order of a pay-per-use gateway.

Go debug

Querying Gateway Constraints

hcloud APIG ShowRestrictionOfInstanceV2

This API is used to query the constraints of a gateway.

Go debug

Querying VPC Endpoint Connections

hcloud APIG ListEndpointConnections

This API is used to query the VPC endpoint connections of a gateway.

Go debug

Accepting or Rejecting a VPC Endpoint Connection

hcloud APIG AcceptOrRejectEndpointConnections

This API is used to accept or reject a VPC endpoint connection for a gateway.

Go debug

Querying Whitelist Records of a VPC Endpoint Service

hcloud APIG ListEndpointPermissions

This API is used to query the whitelist records of a gateway's VPC endpoint service.

Go debug

Adding Whitelist Records for a VPC Endpoint Service

hcloud APIG AddEndpointPermissions

This API is used to add whitelist records in batches for a gateway's VPC endpoint service.

Go debug

Deleting Whitelist Records of a VPC Endpoint Service

hcloud APIG DeleteEndpointPermissions

This API is used to delete whitelist records of a gateway's VPC endpoint service in batches.

Go debug

Querying All Gateway Tags of a Project

hcloud APIG ListProjectInstanceTags

This API is used to query all gateway tags of a project.

Go debug

Querying Tags of a Gateway

hcloud APIG ListInstanceTags

This API is used to query all tags of a gateway.

Go debug

Adding or Deleting Tags of a Gateway

hcloud APIG BatchCreateOrDeleteInstanceTags

This API is used to add tags to a gateway or delete the tags of a gateway.

Go debug

Querying the Number of Gateways with a Specified Tag

hcloud APIG ShowInstancesNumByTags

This API is used to query the number of gateways with a specified tag.

Go debug

Querying Gateways by Tag

hcloud APIG ListInstancesByTags

This API is used to query gateways by tag.

Go debug

Importing a Microservice

hcloud APIG ImportMicroservice

This API is used to import a microservice.

Go debug

Querying SSL Certificates

hcloud APIG ListCertificatesV2

This API is used to query the SSL certificates.

Go debug

Creating an SSL Certificate

hcloud APIG CreateCertificateV2

This API is used to create an SSL certificate.

Go debug

Binding a Domain Name with SSL Certificates

hcloud APIG BatchAssociateCertsV2

This API is used to bind a domain name with SSL certificates. Currently, only one certificate ID can be specified in certificate_ids. For gateways with custom inbound ports, the same domain name is bound to a certificate at the same time. Enabling or disabling client verification takes effect for different ports of the same domain name.

Go debug

Unbinding a Domain Name's SSL Certificates

hcloud APIG BatchDisassociateCertsV2

This API is used to unbind a domain name's SSL certificates. Currently, only one certificate ID can be specified in certificate_ids. For gateways with custom inbound ports, the same domain name will be unbound from the certificate at the same time.

Go debug

Querying Certificate Details

hcloud APIG ShowDetailsOfCertificateV2

This API is used to query details about a certificate.

Go debug

Deleting an SSL Certificate

hcloud APIG DeleteCertificateV2

This API is used to delete an SSL certificate. Only certificates that are not bound to any domain name can be deleted.

Go debug

Modifying an SSL Certificate

hcloud APIG UpdateCertificateV2

This API is used to modify an SSL certificate.

Go debug

Binding an SSL Certificate to a Domain Name

hcloud APIG BatchAssociateDomainsV2

This API is used to bind an SSL certificate to a domain name. For gateways with custom inbound ports, the same domain name is bound to a certificate at the same time. Enabling or disabling client verification takes effect for different ports of the same domain name.

Go debug

Unbinding an SSL Certificate from a Domain Name

hcloud APIG BatchDisassociateDomainsV2

This API is used to unbind an SSL certificate from a domain name. For gateways with custom inbound ports, the same domain name will be unbound from the certificate at the same time.

Go debug

Querying Domain Names of an SSL Certificate

hcloud APIG ListAttachedDomainsV2

This API is used to query the domain names to which an SSL certificate has been bound.

Go debug

Creating a Plug-in

hcloud APIG CreatePlugin

Plug-in information.

Go debug

Querying Plug-ins

hcloud APIG ListPlugins

This API is used to query details about a group of plug-ins that meet specified conditions.

Go debug

Modifying a Plug-in

hcloud APIG UpdatePlugin

This API is used to modify a plug-in.

Go debug

Deleting a Plug-in

hcloud APIG DeletePlugin

This API is used to delete a plug-in.

Go debug

Querying Plug-in Details

hcloud APIG ShowPlugin

This API is used to query the details of a plug-in.

Go debug

Binding a Plug-in to APIs

hcloud APIG AttachApiToPlugin

This API is used to bind a plug-in to APIs.

Go debug

Unbinding a Plug-in from All APIs

hcloud APIG DetachApiFromPlugin

This API is used to unbind a plug-in from all APIs to which it has been bound.

Go debug

Querying APIs Bound with a Plug-in

hcloud APIG ListPluginAttachedApis

This API is used to query the APIs to which a plug-in has been bound.

Go debug

Querying APIs to Which a Plug-in Can Be Bound

hcloud APIG ListPluginAttachableApis

This API is used to query the APIs to which a plug-in can be bound.

Go debug

Binding an API with Plug-ins

hcloud APIG AttachPluginToApi

This API is used to bind an API with plug-ins.

Go debug

Unbinding an API's Plug-ins

hcloud APIG DetachPluginFromApi

This API is used to unbind an API's plug-ins.

Go debug

Querying Plug-ins Bound to an API

hcloud APIG ListApiAttachedPlugins

This API is used to query the plug-ins bound to an API.

Go debug

Querying Plug-ins That Can Be Bound to an API

hcloud APIG ListApiAttachablePlugins

This API is used to query the plug-ins that can be bound to a specified API.

Go debug

Creating an App

hcloud APIG CreateAnAppV2

An app is an identity for accessing an API. An app can call the APIs to which it has been authorized.

Go debug

Querying Apps

hcloud APIG ListAppsV2

This API is used to query apps.

Go debug

Obtaining App Details

hcloud APIG ShowDetailsOfAppV2

This API is used to query the details of an app.

Go debug

Deleting an App

hcloud APIG DeleteAppV2

This API is used to delete an app.

Go debug

Modifying an App

hcloud APIG UpdateAppV2

This API is used to modify the information about an app. The name, remark, related_domain_id and related_project_id can be modified.

Go debug

Resetting the AppSecret of an App

hcloud APIG ResettingAppSecretV2

This API is used to reset the AppSecret of an app.

Go debug

Verifying an App

hcloud APIG CheckAppV2

This API is provided for users (excluding app owner) to check whether an app exists. Only the basic information, such as ID, name, and remark, of the app is displayed.

Go debug

Creating an AppCode

hcloud APIG CreateAppCodeV2

This API is used to create an AppCode for an app for simple authentication.

Go debug

Generating an AppCode

hcloud APIG CreateAppCodeAutoV2

This API is used to generate a random AppCode.

Go debug

Querying AppCodes of an App

hcloud APIG ListAppCodesV2

This API is used to query the AppCodes of an app.

Go debug

Querying Details of an AppCode

hcloud APIG ShowDetailsOfAppCodeV2

This API is used to query the details of an AppCode created for an app for simple authentication.

Go debug

Deleting an AppCode

hcloud APIG DeleteAppCodeV2

This API is used to delete an AppCode. Deleted AppCodes cannot be used for simple authentication.

Go debug

Querying Quotas Associated with a Credential

hcloud APIG ShowAppBoundAppQuota

This API is used to query quotas associated with a specified credential.

Go debug

Configuring Access Control Settings for an App

hcloud APIG UpdateAppAcl

This API is used to configure access control settings for a credential.

Go debug

Querying Details About App Access Control

hcloud APIG ShowDetailsOfAppAcl

This API is used to query the access control details about an app.

Go debug

Deleting Access Control Settings of an App

hcloud APIG DeleteAppAcl

This API is used to delete the access control settings of a credential.

Go debug

Querying AIAPIKEYs of an App.

hcloud APIG ListAiApiKeys

Querying AIAPIKEYs of an App.

Go debug

Querying AIAPIKEY Details.

hcloud APIG ShowDetailsOfAiApiKey

Querying AIAPIKEY Details.

Go debug

Deleting an AIAPIKey.

hcloud APIG DeleteAiApiKey

Deleting an AIAPIKey.After deletion, the AIAPIKey will no longer be usable for authentication.

Go debug

Querying Credential Quotas

hcloud APIG ListAppQuotas

This API is used to query credential quotas. Fuzzy query by name is supported.

Go debug

Creating a Credential Quota

hcloud APIG CreateAppQuota

This API is used to create a credential quota.

Go debug

Querying Credential Quota Details

hcloud APIG ShowAppQuota

This API is used to query credential quota details.

Go debug

Modifying a Credential Quota

hcloud APIG UpdateAppQuota

This API is used to modify a credential quota.

Go debug

Deleting a Credential Quota

hcloud APIG DeleteAppQuota

This API is used to delete a credential quota. When a credential quota is deleted, the association between the quota and credential is also deleted.

Go debug

Querying the Credentials Bound to a Specified Quota

hcloud APIG ListAppQuotaBoundApps

This API is used to query the credentials bound to a credential quota. Fuzzy match by credential name is supported.

Go debug

Binding a Credential Quota with Credentials

hcloud APIG AssociateAppsForAppQuota

This API is used to bind a credential quota with credentials.

Go debug

Unbinding a Credential Quota from a Credential

hcloud APIG DisassociateAppQuotaWithApp

This API is used to unbind a credential quota from a credential.

Go debug

Querying Credentials That Can Be Bound to a Credential Quota

hcloud APIG ListAppQuotaBindableApps

This API is used to query the credentials that can be bound to a credential quota. Fuzzy search by credential name is supported.

Go debug

Create an AIAPIKey

hcloud APIG CreateAiApiKey

Create an AIAPIKey for API key authentication in AI scenarios.

Go debug

Exporting APIs Asynchronously

hcloud APIG ExportApiDefinitionsAsync

This API is used to export APIs in a specified API group. The content of the exported file complies with the Swagger standard. For details about the custom extended fields of APIG, see section "Importing and Exporting APIs" > "Extended Definition" in the API Gateway User Guide.

Go debug

Importing APIs Asynchronously

hcloud APIG ImportApiDefinitionsAsync

This API is used to import APIs. The content of the imported file must comply with the Swagger standard. For details about the custom extended fields of APIG, see section "Importing and Exporting APIs" > "Extended Definition" in the API Gateway User Guide.

Go debug

Querying the Result of an Asynchronous Task

hcloud APIG ShowAsyncTaskResult

This API is used to query the result of an asynchronous task.

Go debug

Creating an Orchestration Rule

hcloud APIG CreateOrchestration

This API is used to create an orchestration rule.

Go debug

Viewing Orchestration Rules

hcloud APIG ListOrchestrations

This API is used to view orchestration rules.

Go debug

Querying Rule Details

hcloud APIG ShowDetailsOfOrchestration

This API is used to query orchestration rule details.

Go debug

Updating an Orchestration Rule

hcloud APIG UpdateOrchestration

This API is used to update an orchestration rule.

Go debug

Deleting an Orchestration Rule

hcloud APIG DeleteOrchestration

This API is used to delete an orchestration rule.

Go debug

Querying APIs to Which an Orchestration Rule Is Bound

hcloud APIG ListOrchestrationAttachedApis

This API is used to query the APIs to which a specified plug-in has been bound.

Go debug

Querying the Domain Name Bound to a Custom Inbound Port

hcloud APIG ListCustomIngressPortDomains

This API is used to query the domain name bound to a custom inbound port.

Go debug

Querying the Custom Inbound Ports of a Gateway

hcloud APIG ListCustomIngressPorts

This API is used to query the custom inbound ports of a gateway.

Go debug

Adding an Inbound Port for a Gateway

hcloud APIG AddCustomIngressPort

This API is used to add an inbound port for a gateway. In the same gateway, a port can only support one protocol.

Go debug

Deleting an Inbound Port of a Gateway

hcloud APIG DeleteCustomIngressPort

This API is used to delete an inbound port of a gateway, not including ports 80 and 443.

Go debug