All Products
Search
Document Center

API Gateway:HttpApiPublishRevisionInfo

Last Updated:Mar 31, 2025
ParameterTypeDescriptionExample
object

The version information.

revisionIdstring

The published version.

apr-xxx
environmentInfoobject

The environment information.

environmentIdstring

The environment ID.

env-xxx
namestring

The environment name.

test
aliasstring

The environment alias.

Test
gatewayInfoobject

The instance information.

gatewayIdstring

The instance ID.

gw-xxx
namestring

The instance name.

Instance 1
subDomainsarray

The default domain names of the environment.

HttpApiDomainInfo

The domain name information.

customDomainsarray

The custom domain names.

HttpApiDomainInfo

The domain name information.

backendScenestring

The publishing scenario.

Valid values:

  • SingleService
  • MultiServiceByRatio
  • MultiServiceByContent
  • MultiServiceByTag
  • Mock
SingleService
backendTypestring

The type of the backend service.

Valid values:

  • DNS: a DNS domain name
  • Service: an existing service
  • VIP: a fixed IP address
  • CloudProduct: a cloud service
Service
serviceConfigsarray<object>

The configurations of existing services. For single-service publishing, only one entry is allowed. For other scenarios, multiple entries are allowed.

object
gatewayServiceIdstring

The service ID.

gs-xxx
portinteger

The service port.

8080
protocolstring

The service protocol.

HTTP
weightinteger

The service weight.

100
versionstring

The service version.

v1
matchHttpApiBackendMatchConditions

The matching conditions.

dnsConfigsarray<object>

The configurations of DNS domain names. For single-service publishing, only one entry is allowed. For other scenarios, multiple entries are allowed.

object

The configuration of a single DNS domain name.

dnsListarray

The DNS domain names.

string

The configuration of a single DNS domain name. Format: Domain name:Port.

www.example.com:80
weightinteger

The weight. Valid values: [1,100]. This parameter is valid only in proportional routing.

100
matchHttpApiBackendMatchConditions

The matching condition. This condition is valid only in content-based routing.

vipConfigsarray<object>

The configurations of fixed IP addresses. For single-service publishing, only one entry is allowed. For other scenarios, multiple entries are allowed.

object

The fixed IP address configurations.

endpointsarray

The IP addresses.

string

The configuration of a single IP address. Format: IP address:Port.

192.168.1.100:8080
weightinteger

The weight. Valid values: [1,100]. This parameter is valid only in proportional routing.

100
matchHttpApiBackendMatchConditions

The matching condition. This condition is valid only in content-based routing.

cloudProductConfigobject

The cloud service configurations.

cloudProductTypestring

The type of the cloud service.

FC
functionConfigsarray<object>

The Function Compute configurations.

object
namestring

The function name.

demo-function
qualifierstring

The function version or alias.

LATEST
gatewayServiceIdstring

The associated service ID.

gs-xxx
weightinteger

The service weight.

100
matchHttpApiBackendMatchConditions

The matching conditions.

containerServiceConfigsarray<object>

The ACK configurations.

object
gatewayServiceIdstring

The associated service ID.

gs-xxx
namestring

The K8s service name.

demo-service
namespacestring

The K8s namespace.

default
protocolstring

The service protocol.

HTTP
weightstring

The service weight.

100
matchHttpApiBackendMatchConditions

The matching conditions.

portinteger

The service port.

8080
mseNacosConfigsarray<object>

The MSE Nacos configurations.

object
gatewayServiceIdstring

The associated service ID.

gs-xxx
namestring

The Nacos service name.

spring-demo
namespacestring

The Nacos namespace.

public
groupNamestring

The service group.

DEFAULT_GROUP
weightinteger

The service weight.

100
matchHttpApiBackendMatchConditions

The matching conditions.

operationsarray

The operations.

HttpApiOperationInfo

The operation information.

createTimestamplong

The publishing timestamp.

1718807057927
isCurrentVersionboolean

Specifies whether the current version is used.

true