All Products
Search
Document Center

OnsInstanceBaseInfo

Last Updated: Sep 13, 2019

OnsInstanceBaseInfo

You can call this operation to query basic instance information and endpoints for sending and receiving messages.

Request parameters

Name Type Required Description
InstanceId String Yes The ID of the instance.
PreventCache Long Yes The parameter used for Cross Site Request Forgery (CSRF) verification, which can be set to the current system time. Unit: ms

Response parameters

Name Type Description
RequestId String A common parameter. Each request has a unique ID.
HelpUrl String A help link.
InstanceBaseInfo InstanceBaseInfo The instance information object.

Fields in InstanceBaseInfo

Name Type Description
InstanceId String The ID of the instance.
InstanceName String The name of the instance.
InstanceType Integer The type of the instance. Valid values:
  • 1: Pay-As-You-Go instance
  • 2: Enterprise Platinum Edition instance
InstanceStatus Integer The status of the instance. Valid values:
  • 0: An Enterprise Platinum Edition instance is being deployed.
  • 2: The payment for a Pay-As-You-Go instance is overdue.
  • 5: A Pay-As-You-Go or Enterprise Platinum Edition instance is in service.
  • 7: An Enterprise Platinum Edition instance is being upgraded and is available.
ReleaseTime Long The automatic release time of Enterprise Platinum Edition instances.
Endpoints Endpoints The endpoint corresponding to each protocol.

Fields in Endpoints

Name Type Null Description
TcpEndpoint String No The TCP endpoint for MQ.
HttpInternetEndpoint String Yes The Internet HTTP endpoint for MQ.
HttpInternetSecureEndpoint String Yes The Internet HTTPS endpoint for MQ.
HttpInternalEndpoint String Yes The intranet HTTP endpoint for MQ.

Examples

For more information about sample codes, see API sample code and endpoints.