Help Center/ API Gateway/ API Reference/ Dedicated Gateway APIs (V2)/ Group Response Management/ Creating a Group Response

Updated on 2025-10-24 GMT+08:00

Online Debugging

CLI Examples

View PDF

Creating a Group Response

Function

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

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-responses

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain it, see Obtaining a Project ID.
instance_id	Yes	String	Gateway ID, which can be obtained from the gateway information on the APIG console.
group_id	Yes	String	API group ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
name	Yes	String	Response name. Enter 1 to 64 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.
responses	No	Map<String,ResponseInfo>	Response type definition. key indicates the error type. Options of key: AUTH_FAILURE: Authentication failed. AUTH_HEADER_MISSING: The identity source is missing. AUTHORIZER_FAILURE: Custom authentication failed. AUTHORIZER_CONF_FAILURE: Custom authorizer error. AUTHORIZER_IDENTITIES_FAILURE: The identity source of the custom authorizer is invalid. BACKEND_UNAVAILABLE: The backend is unavailable. BACKEND_TIMEOUT: Backend timed out. THROTTLED: The request was rejected due to throttling. UNAUTHORIZED: The app you are using has not been authorized to call the API. ACCESS_DENIED: Access denied. NOT_FOUND: No API is found. REQUEST_PARAMETERS_FAILURE: Invalid request parameter. DEFAULT_4XX: Default 4XX error occurred. DEFAULT_5XX: Default 5XX error occurred. THIRD_AUTH_FAILURE: Third-party authentication failed. THIRD_AUTH_IDENTITIES_FAILURE: Identity source of the third-party authorizer is invalid. THIRD_AUTH_CONF_FAILURE: Third-party authorizer configuration error. OIDC_AUTH_TOKEN_VERIFY_FAIL: OIDC authentication token verification failed. OIDC_AUTH_GET_DISCOVERY_ERROR: Information fails to be obtained from the configured discovery during OIDC authentication. OIDC_AUTH_CODE_FLOW_FAIL: The authorization code process failed during OIDC authentication. JWT_AUTH_FAILURE: JWT authentication token verification failed. ORCHESTRATION_PARAMETER_NOT_FOUND: No parameters are input to match the parameter orchestration rule, causing orchestration failure. ORCHESTRATION_FAILURE: Parameter orchestration failed. No orchestration rule to match. Each error type is in JSON format.

**Table 4** ResponseInfo
Parameter	Mandatory	Type	Description
status	No	Integer	HTTP status code of the response. The value ranges from 200 to 599, but cannot be 444.
body	No	String	Response body template.
headers	No	Array of ResponseInfoHeader objects	Custom response header. Array Length: 0 - 10

**Table 5** ResponseInfoHeader
Parameter	Mandatory	Type	Description
key	No	String	Key of the custom group response header, which can contain 1 to 128 characters of letters, digits, and hyphens (-).
value	No	String	Value of the custom group response header, which is a string of 1 to 1,024 characters. Minimum: 1 Maximum: 1024

Response Parameters

Status code: 201

**Table 6** Response body parameters
Parameter	Type	Description
name	String	Response name.
responses	Map<String,ResponseInfoResp>	Response type definition. key indicates the error type. Options of key: AUTH_FAILURE: Authentication failed. AUTH_HEADER_MISSING: The identity source is missing. AUTHORIZER_FAILURE: Custom authentication failed. AUTHORIZER_CONF_FAILURE: Custom authorizer error. AUTHORIZER_IDENTITIES_FAILURE: The identity source of the custom authorizer is invalid. BACKEND_UNAVAILABLE: The backend is unavailable. BACKEND_TIMEOUT: Backend timed out. THROTTLED: The request was rejected due to throttling. UNAUTHORIZED: The app you are using has not been authorized to call the API. ACCESS_DENIED: Access denied. NOT_FOUND: No API is found. REQUEST_PARAMETERS_FAILURE: Invalid request parameter. DEFAULT_4XX: Default 4XX error occurred. DEFAULT_5XX: Default 5XX error occurred. THIRD_AUTH_FAILURE: Third-party authentication failed. THIRD_AUTH_IDENTITIES_FAILURE: Identity source of the third-party authorizer is invalid. THIRD_AUTH_CONF_FAILURE: Third-party authorizer configuration error. OIDC_AUTH_TOKEN_VERIFY_FAIL: OIDC authentication token verification failed. OIDC_AUTH_GET_DISCOVERY_ERROR: Information fails to be obtained from the configured discovery during OIDC authentication. OIDC_AUTH_CODE_FLOW_FAIL: The authorization code process failed during OIDC authentication. JWT_AUTH_FAILURE: JWT authentication token verification failed. ORCHESTRATION_PARAMETER_NOT_FOUND: No parameters are input to match the parameter orchestration rule, causing orchestration failure. ORCHESTRATION_FAILURE: Parameter orchestration failed. No orchestration rule to match. Each error type is in JSON format.
id	String	Response ID.
default	Boolean	Indicates whether the group response is the default response.
create_time	String	Creation time.
update_time	String	Update time.

**Table 7** ResponseInfoResp
Parameter	Type	Description
status	Integer	HTTP status code of the response. The value ranges from 200 to 599, but cannot be 444.
body	String	Response body template.
headers	Array of ResponseInfoHeader objects	Custom response header. Array Length: 0 - 10
default	Boolean	Indicates whether the response is the default response.

**Table 8** ResponseInfoHeader
Parameter	Type	Description
key	String	Key of the custom group response header, which can contain 1 to 128 characters of letters, digits, and hyphens (-).
value	String	Value of the custom group response header, which is a string of 1 to 1,024 characters. Minimum: 1 Maximum: 1024

Status code: 400

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 401

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 403

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 404

**Table 12** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 13** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

Creating a response for an API group

{
  "name" : "response_demo"
}

Example Responses

Status code: 201

Created

{
  "create_time" : "2020-08-12T14:52:02.829753306+08:00",
  "update_time" : "2020-08-12T14:52:02.829753306+08:00",
  "default" : false,
  "id" : "e839b367e10f4ab19d1c5008e476b83a",
  "name" : "response_demo",
  "responses" : {
    "ACCESS_DENIED" : {
      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
      "default" : true,
      "status" : 403
    },
    "AUTHORIZER_CONF_FAILURE" : {
      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
      "default" : true,
      "status" : 500
    },
    "AUTHORIZER_FAILURE" : {
      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
      "default" : true,
      "status" : 500
    },
    "AUTHORIZER_IDENTITIES_FAILURE" : {
      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
      "default" : true,
      "status" : 401
    },
    "AUTH_FAILURE" : {
      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
      "default" : true,
      "status" : 401
    },
    "AUTH_HEADER_MISSING" : {
      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
      "default" : true,
      "status" : 401
    },
    "BACKEND_TIMEOUT" : {
      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
      "default" : true,
      "status" : 504
    },
    "BACKEND_UNAVAILABLE" : {
      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
      "default" : true,
      "status" : 502
    },
    "DEFAULT_4XX" : {
      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
      "default" : true
    },
    "DEFAULT_5XX" : {
      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
      "default" : true
    },
    "NOT_FOUND" : {
      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
      "default" : true,
      "status" : 404
    },
    "REQUEST_PARAMETERS_FAILURE" : {
      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
      "default" : true,
      "status" : 400
    },
    "THROTTLED" : {
      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
      "default" : true,
      "status" : 429
    },
    "UNAUTHORIZED" : {
      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
      "default" : true,
      "status" : 401
    },
    "THIRD_AUTH_FAILURE" : {
      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
      "default" : true,
      "status" : 401
    },
    "THIRD_AUTH_IDENTITIES_FAILURE" : {
      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
      "default" : true,
      "status" : 401
    },
    "THIRD_AUTH_CONF_FAILURE" : {
      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
      "default" : true,
      "status" : 500
    },
    "OIDC_AUTH_TOKEN_VERIFY_FAIL" : {
      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
      "default" : true,
      "status" : 401
    },
    "OIDC_AUTH_GET_DISCOVERY_ERROR" : {
      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
      "default" : true,
      "status" : 400
    },
    "OIDC_AUTH_CODE_FLOW_FAIL" : {
      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
      "default" : true,
      "status" : 401
    },
    "JWT_AUTH_FAILURE" : {
      "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
      "default" : true,
      "status" : 401
    }
  }
}

Status code: 400

Bad Request

{
  "error_code" : "APIG.2011",
  "error_msg" : "Invalid parameter value,parameterName:name. Please refer to the support documentation"
}

Status code: 401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

Status code: 403

Forbidden

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

Status code: 404

Not Found

{
  "error_code" : "APIG.3001",
  "error_msg" : "API group c77f5e81d9cb4424bf704ef2b0ac7600 does not exist"
}

Status code: 500

Internal Server Error

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

Status Codes

Status Code	Description
201	Created
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
500	Internal Server Error

Error Codes

See Error Codes.

Parent topic: Group Response Management

Previous topic: Group Response Management

Next topic: Querying Group Response Details

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot