All Products
Search
Document Center

API Gateway:HttpApiResponseContract

Last Updated:Aug 28, 2026

Parameter

Type

Description

Example

object

The response format defined for the HTTP API.

contentType

string

The content type of the response.

application/json

items

array

The response definitions.

object

The response body.

code

integer

The HTTP status code.

200

example

string

A sample response value.

{"result": "ok"}

description

string

A description of the response.

正常接口响应

jsonSchema

string

The JSON schema of the response body.

{ "type": "object", "required": [ "result" ], "properties": { "result": { "type": "string", "description": "操作结果,'ok' 表示成功" } } }