Querying API Details¶
Function¶
This API is used to query the details of an API.
Calling Method¶
For details, see Calling APIs.
URI¶
GET /v2/{project_id}/apigw/instances/{instance_id}/apis/{api_id}
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. |
api_id | Yes | String | API ID. |
Request 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. |
Response Parameters¶
Status code: 200
Parameter | Type | Description |
---|---|---|
name | String | API name. It can contain 3 to 255 characters, starting with a letter or digit. Only letters, digits, and these special characters are allowed: -_./:() |
type | Integer | API type.
Enumeration values:
|
version | String | API version. Maximum: 16 |
req_protocol | String | API request protocol:
Default: HTTPS Enumeration values:
|
req_method | String | API request method. If the request protocol is set to GRPC, the request method is fixed to POST. Enumeration values:
|
req_uri | String | Request address, which can contain request parameters enclosed with braces ({}). For example, /getUserInfo/{userId}. Special characters, such as asterisks ( Note The address must comply with the URI specifications. |
auth_type | String | API authentication mode. Options:
Custom authentication is unavailable if the request protocol is set to GRPC. Enumeration values:
|
auth_opt | AuthOpt object | Security authentication parameter. |
cors | Boolean | Indicates whether CORS is supported.
Default: false Enumeration values:
|
match_mode | String | API matching mode:
Enumeration values:
|
backend_type | String | Backend type. Options:
Enumeration values:
|
remark | String | API description. It cannot exceed 255 characters. |
group_id | String | ID of the API group to which the API belongs. |
body_remark | String | API request body, which can be an example request body, media type, or parameters. Ensure that the request body does not exceed 20,480 characters. |
result_normal_sample | String | Example response for a successful request. Ensure that the response does not exceed 20,480 characters. This is unavailable if the request protocol is set to GRPC. |
result_failure_sample | String | Example response for a failed request. Ensure that the response does not exceed 20,480 characters. This is unavailable if the request protocol is set to GRPC. |
authorizer_id | String | Custom authorizer ID. This is unavailable if the request protocol is set to GRPC. |
tags | Array of strings | Tag. Use letters, digits, and special characters By default, 10 tags are supported. To increase the quota, contact technical support to modify the API_TAG_NUM_LIMIT configuration. Minimum: 1 Maximum: 128 |
response_id | String | Group response ID. |
roma_app_id | String | Integration application ID. Currently, this parameter is not supported. |
domain_name | String | Custom domain name bound to the API. Currently, this parameter is not supported. |
tag | String | Tag. This field will be deprecated. You can use the tags field instead. |
content_type | String | Request content type:
Coming soon. Enumeration values:
|
id | String | API ID. |
status | Integer | App status.
|
arrange_necessary | Integer | Indicates whether to enable orchestration. |
register_time | String | Time when the API is registered. |
update_time | String | Time when the API was last modified. |
group_name | String | Name of the API group to which the API belongs. |
group_version | String | Version of the API group to which the API belongs. The default value is V1. Other versions are not supported. Default: V1 |
run_env_id | String | ID of the environment in which the API has been published. Separate multiple environment IDs with vertical bars (|). |
run_env_name | String | Name of the environment in which the API has been published. Separate multiple environment names with vertical bars (|). |
publish_id | String | Publication record ID. Separate multiple publication record IDs with vertical bars (|). |
publish_time | String | Publication time. Separate the time of multiple publication records with vertical bars (|). |
roma_app_name | String | Name of the integration application to which the API belongs. Currently, this parameter is not supported. |
ld_api_id | String | ID of the corresponding custom backend API. Currently, this parameter is not supported. |
backend_api | BackendApi object | Web backend details. |
api_group_info | ApiGroupCommonInfo object | API group information. |
func_info | ApiFunc object | FunctionGraph backend details. |
mock_info | ApiMock object | Mock backend details. |
req_params | Array of ReqParam objects | Request parameters. |
backend_params | Array of BackendParam objects | Backend parameters. |
policy_functions | Array of ApiPolicyFunctionResp objects | FunctionGraph backend policies. |
policy_mocks | Array of ApiPolicyMockResp objects | Mock backend policies. |
policy_https | Array of ApiPolicyHttpResp objects | Web backend policies. |
Parameter | Type | Description |
---|---|---|
app_code_auth_type | String | Indicates whether AppCode authentication is enabled. This parameter is valid only if auth_type is set to App. The default value is DISABLE.
Default: DISABLE Enumeration values:
|
Parameter | Type | Description |
---|---|---|
authorizer_id | String | Custom authorizer ID. This is unavailable if the request protocol is set to GRPC. |
url_domain | String | Backend service address. A backend service address consists of a domain name or IP address and a port number, with not more than 255 characters. It must be in the format "Host name:Port number", for example, apig.example.com:7443. If the port number is not specified, the default HTTPS port 443 or the default HTTP port 80 is used. Environment variables are supported. Each must start with a letter and can consist of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed. |
req_protocol | String | Request protocol. You can select GRPCS for the GRPC backend. Enumeration values:
|
remark | String | Description. It cannot exceed 255 characters. |
req_method | String | Request method. For the GRPC backend, the request method is fixed to POST. Enumeration values:
|
version | String | Web backend version, which can contain a maximum of 16 characters. |
req_uri | String | Request address, which can contain request parameters enclosed with braces ({}). For example, /getUserInfo/{userId}. Special characters, such as asterisks ( Environment variables are supported. Each must start with a letter and can consist of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed. Note The address must comply with the URI specifications. For the GRPC backend, the request address is fixed to /. |
timeout | Integer | Timeout allowed for APIG to request the backend service. You can set the maximum timeout using the backend_timeout configuration item. The maximum value is 600,000. Unit: ms. Minimum: 1 |
enable_client_ssl | Boolean | Indicates whether to enable two-way authentication. |
retry_count | String | Number of retry attempts to request the backend service. The default value is -1. The value ranges from -1 to 10. -1 indicates that idempotent APIs will retry once and non-idempotent APIs will not retry. POST and PATCH are non-idempotent. GET, HEAD, PUT, OPTIONS, and DELETE are idempotent. Default: -1 |
id | String | ID. |
status | Integer | Backend service status.
|
register_time | String | Registration time. |
update_time | String | Update time. |
vpc_channel_info | VpcInfo object | VPC channel details. This parameter is required if vpc_channel_status is set to 1. |
vpc_channel_status | Integer | Indicates whether to use a VPC channel.
|
Parameter | Type | Description |
---|---|---|
id | String | ID. |
name | String | API group name. |
status | Integer | Status.
Enumeration values:
|
sl_domain | String | Subdomain name that APIG automatically allocates to the API group. |
register_time | String | Creation time. |
update_time | String | Last modification time. |
on_sell_status | Integer | Indicates whether the API group has been listed on KooGallery.
Not supported currently. |
url_domains | Array of UrlDomain objects | Independent domain names bound to the API group. |
sl_domain_access_enabled | Boolean | Whether the debugging domain name is accessible. Options: true and false. Default: true |
Parameter | Type | Description |
---|---|---|
id | String | Domain ID. |
domain | String | Domain name. |
cname_status | Integer | CNAME resolution status of the domain name.
|
ssl_id | String | SSL certificate ID. |
ssl_name | String | SSL certificate name. |
min_ssl_version | String | Minimum SSL version. TLS 1.1 and TLS 1.2 are supported. Default: TLSv1.1 Enumeration values:
|
verified_client_certificate_enabled | Boolean | Whether to enable client certificate verification. This parameter is available only when a certificate is bound. It is enabled by default if trusted_root_ca exists, and disabled if trusted_root_ca does not exist. Default: false |
is_has_trusted_root_ca | Boolean | Whether a trusted root certificate (CA) exists. The value is true if trusted_root_ca exists in the bound certificate. Default: false |
Parameter | Type | Description |
---|---|---|
function_urn | String | Function URN. |
remark | String | Description. It cannot exceed 255 characters. |
invocation_type | String | Invocation mode.
Enumeration values:
|
network_type | String | Function network architecture.
Enumeration values:
|
version | String | Function version. If both a function alias URN and version are passed, only the alias URN will be used. Maximum: 64 |
alias_urn | String | Function alias URN. If both a function alias URN and version are passed, the alias URN will be used and the version will be ignored. |
timeout | Integer | Timeout allowed for APIG to request the backend service. If the function network architecture is set to V1, the maximum timeout is 60,000. If the network architecture is set to V2, the maximum timeout is 600,000 and can be modified by using the gateway parameter backend_timeout. Unit: ms. Minimum: 1 |
authorizer_id | String | Backend custom authorizer ID. |
req_protocol | String | Backend request protocol of a function. The value can be HTTPS (default) or GRPCS (available when the frontend request protocol is GRPCS). Default: HTTPS Enumeration values:
|
id | String | ID. |
register_time | String | Registration time. |
status | Integer | Backend service status.
|
update_time | String | Update time. |
Parameter | Type | Description |
---|---|---|
remark | String | Description. It cannot exceed 255 characters. |
result_content | String | Response. |
version | String | Function version. It cannot exceed 64 characters. |
authorizer_id | String | Backend custom authorizer ID. |
id | String | ID. |
register_time | String | Registration time. |
status | Integer | Backend service status.
|
update_time | String | Update time. |
Parameter | Type | Description |
---|---|---|
name | String | Parameter name. The parameter name can contain 1 to 32 characters and must start with a letter. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed. |
type | String | Parameter type. Enumeration values:
|
location | String | Parameter location. Enumeration values:
|
default_value | String | Default value. |
sample_value | String | Example value. |
required | Integer | Indicates whether the parameter is required. 1: yes 2: no The value of this parameter is 1 if Location is set to PATH, and 2 if Location is set to another value. Enumeration values:
|
valid_enable | Integer | Indicates whether validity check is enabled.
Default: 2 Enumeration values:
|
remark | String | Description. It cannot exceed 255 characters. |
enumerations | String | Enumerated value. |
min_num | Integer | Minimum value. This parameter is valid when type is set to NUMBER. |
max_num | Integer | Maximum value. This parameter is valid when type is set to NUMBER. |
min_size | Integer | Minimum length. This parameter is valid when type is set to STRING. |
max_size | Integer | Maximum length. This parameter is valid when type is set to STRING. |
regular | String | Regular expression validation rule. Currently, this parameter is not supported. |
json_schema | String | JSON validation rule. Currently, this parameter is not supported. |
pass_through | Integer | Indicates whether to transparently transfer the parameter. 1: yes 2: no Enumeration values:
|
id | String | Parameter ID. |
Parameter | Type | Description |
---|---|---|
function_urn | String | Function URN. |
invocation_type | String | Invocation mode.
Enumeration values:
|
network_type | String | Function network architecture.
Enumeration values:
|
version | String | Function version. If both a function alias URN and version are passed, the alias URN will be used and the version will be ignored. Maximum: 64 |
alias_urn | String | Function alias URN. If both a function alias URN and version are passed, the alias URN will be used and the version will be ignored. |
timeout | Integer | Timeout allowed for APIG to request the backend service. If the function network architecture is set to V1, the maximum timeout is 60,000. If the network architecture is set to V2, the maximum timeout is 600,000 and can be modified by using the gateway parameter backend_timeout. Unit: ms. Minimum: 1 |
req_protocol | String | Backend request protocol of a function. The value can be HTTPS (default) or GRPCS (available when the frontend request protocol is GRPCS). Default: HTTPS Enumeration values:
|
id | String | ID. |
effect_mode | String | Effective mode of the backend policy.
Enumeration values:
|
name | String | Backend name, which must start with a letter and can contain letters, digits, and underscores (_). Minimum: 3 Maximum: 64 |
backend_params | Array of BackendParam objects | Backend parameters. |
conditions | Array of CoditionResp objects | Policy conditions. |
authorizer_id | String | Backend custom authorizer ID. |
Parameter | Type | Description |
---|---|---|
id | String | ID. |
effect_mode | String | Effective mode of the backend policy.
Enumeration values:
|
name | String | Backend name, which must start with a letter and can contain letters, digits, and underscores (_). Minimum: 3 Maximum: 64 |
backend_params | Array of BackendParam objects | Backend parameters. |
conditions | Array of CoditionResp objects | Policy conditions. |
authorizer_id | String | Backend custom authorizer ID. |
result_content | String | Response. |
Parameter | Type | Description |
---|---|---|
id | String | ID. |
effect_mode | String | Effective mode of the backend policy.
Enumeration values:
|
name | String | Backend name, which must start with a letter and can contain letters, digits, and underscores (_). Minimum: 3 Maximum: 64 |
backend_params | Array of BackendParam objects | Backend parameters. |
conditions | Array of CoditionResp objects | Policy conditions. |
authorizer_id | String | Backend custom authorizer ID. |
url_domain | String | Endpoint of the policy backend. An endpoint consists of a domain name or IP address and a port number, with not more than 255 characters. It must be in the format "Domain name:Port number", for example, apig.example.com:7443. If the port number is not specified, the default HTTPS port 443 or the default HTTP port 80 is used. Environment variables are supported. Each must start with a letter and can consist of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed. |
req_protocol | String | Request protocol. Options include HTTP, HTTPS, and GRPCS. You can select GRPCS for a GRPC backend. Enumeration values:
|
req_method | String | Request method. Options include GET, POST, PUT, DELETE, HEAD, PATCH, OPTIONS, and ANY. This is fixed to POST for the GRPC backend. Enumeration values:
|
req_uri | String | Request address, which can contain request parameters enclosed with braces ({}). For example, /getUserInfo/{userId}. Special characters, such as asterisks ( Environment variables are supported. Each must start with a letter and can consist of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed. Note The address must comply with the URI specifications. For the GRPC backend, the request address is fixed to /. |
timeout | Integer | Timeout allowed for APIG to request the backend service. You can set the maximum timeout using the backend_timeout configuration item. The maximum value is 600,000. Unit: ms. Minimum: 1 |
retry_count | String | Number of retry attempts to request the backend service. The default value is -1. The value ranges from -1 to 10. -1 indicates that idempotent APIs will retry once and non-idempotent APIs will not retry. POST and PATCH are non-idempotent. GET, HEAD, PUT, OPTIONS, and DELETE are idempotent. Default: -1 |
vpc_channel_info | VpcInfo object | VPC channel details. This parameter is required if vpc_channel_status is set to 1. |
vpc_channel_status | Integer | Indicates whether to use a VPC channel.
|
Parameter | Type | Description |
---|---|---|
origin | String | Parameter type.
Enumeration values:
|
name | String | Parameter name. The parameter name must start with a letter and can only contain letters, digits, hyphens (-), underscores (_), and periods (.). Minimum: 1 Maximum: 32 |
remark | String | Description, which can contain a maximum of 255 characters. |
location | String | Parameter location. The value can be PATH, QUERY, or HEADER. Enumeration values:
|
value | String | Parameter value, which can contain a maximum of 255 characters. If the origin type is REQUEST, the value of this parameter is the parameter name in req_params. If the origin type is CONSTANT, the value is a constant. If the origin type is SYSTEM, the value is a system parameter name. System parameters include gateway parameters, frontend authentication parameters, and backend authentication parameters. You can set the frontend or backend authentication parameters after enabling custom frontend or backend authentication. The gateway parameters are as follows:
Frontend authentication parameter: prefixed with "$context.authorizer.frontend.". For example, to return "aaa" upon successful custom authentication, set this parameter to "$context.authorizer.frontend.aaa". Backend authentication parameter: prefixed with "$context.authorizer.backend.". For example, to return "aaa" upon successful custom authentication, set this parameter to "$context.authorizer.backend.aaa". |
id | String | Parameter ID. |
req_param_id | String | Request parameter ID. |
Parameter | Type | Description |
---|---|---|
req_param_name | String | Input parameter name. This parameter is required if the policy type is param. |
sys_param_name | String | Name of a built-in gateway parameter. This parameter is required if the policy type is system. The following parameters are supported:
Enumeration values:
|
cookie_param_name | String | COOKIE parameter name. This parameter is required if the policy type is cookie. Minimum: 0 Maximum: 255 |
frontend_authorizer_param_name | String | System parameter: frontend authentication parameter name. This parameter is mandatory when the policy type is frontend_authorizer. The frontend authentication parameter name is prefixed with $context.authorizer.frontend. For example, if the frontend authentication parameter name is user_name, the name with the prefix will be $context.authorizer.frontend.user_name. |
condition_type | String | Policy condition.
This parameter is required when the policy type is param, system, cookie, or frontend_authorizer. Enumeration values:
|
condition_origin | String | Policy type
Enumeration values:
|
condition_value | String | Policy value. This parameter is required when the policy type is param, source, cookie, or frontend_authorizer. |
id | String | ID. |
req_param_id | String | Input parameter ID. |
req_param_location | String | Input parameter location. |
Parameter | Type | Description |
---|---|---|
ecs_id | String | Cloud server ID. |
ecs_name | String | Cloud server name. |
cascade_flag | Boolean | Indicates whether to use the cascading mode. Currently, this parameter is not supported. |
vpc_channel_proxy_host | String | Proxy host. |
vpc_channel_id | String | VPC channel ID. |
vpc_channel_port | Integer | VPC channel port. |
Status code: 401
Parameter | Type | Description |
---|---|---|
error_code | String | Error code. |
error_msg | String | Error message. |
Status code: 403
Parameter | Type | Description |
---|---|---|
error_code | String | Error code. |
error_msg | String | Error message. |
Status code: 404
Parameter | Type | Description |
---|---|---|
error_code | String | Error code. |
error_msg | String | Error message. |
Status code: 500
Parameter | Type | Description |
---|---|---|
error_code | String | Error code. |
error_msg | String | Error message. |
Example Requests¶
None
Example Responses¶
Status code: 200
OK
{
"id" : "5f918d104dc84480a75166ba99efff21",
"tags" : [ "webApi" ],
"arrange_necessary" : 2,
"backend_type" : "HTTP",
"auth_type" : "AUTHORIZER",
"auth_opt" : {
"app_code_auth_type" : "DISABLE"
},
"authorizer_id" : "8d0443832a194eaa84244e0c1c1912ac",
"backend_api" : {
"update_time" : "2020-08-02T16:32:47.077029Z",
"vpc_channel_status" : 1,
"vpc_channel_info" : {
"vpc_channel_id" : "56a7d7358e1b42459c9d730d65b14e59",
"vpc_channel_proxy_host" : "www.example.com"
},
"url_domain" : "56a7d7358e1b42459c9d730d65b14e59",
"req_protocol" : "HTTPS",
"id" : "1ce8fda3586d4371bd83c955df37e102",
"req_method" : "GET",
"register_time" : "2020-07-31T12:42:51Z",
"req_uri" : "/test/benchmark",
"timeout" : 5000,
"status" : 1,
"retry_count" : "-1"
},
"cors" : false,
"status" : 1,
"group_name" : "api_group_001",
"group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
"group_version" : "V1",
"match_mode" : "NORMAL",
"name" : "Api_http",
"req_protocol" : "HTTPS",
"req_method" : "GET",
"req_uri" : "/test/http",
"type" : 1,
"version" : "V0.0.1",
"result_normal_sample" : "Example success response",
"result_failure_sample" : "Example failure response",
"register_time" : "2020-07-31T12:42:51Z",
"update_time" : "2020-08-02T16:32:47.046289Z",
"remark" : "Web backend API",
"backend_params" : [ {
"name" : "X-CONSTANT-HEADER",
"value" : "demo",
"location" : "HEADER",
"origin" : "CONSTANT",
"remark" : "constant_demo",
"id" : "8cb2eba19e7a4423a4e835647a8b8d76"
}, {
"name" : "app-id",
"value" : "$context.appId",
"location" : "HEADER",
"origin" : "SYSTEM",
"remark" : "App ID of the API caller",
"id" : "216ddda836e74d528f364ff589d9dd21"
} ]
}
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.3002",
"error_msg" : "API 5f918d104dc84480a75166ba99efff21 does not exist"
}
Status code: 500
Internal Server Error
{
"error_code" : "APIG.9999",
"error_msg" : "System error"
}
Status Codes¶
Status Code | Description |
---|---|
200 | OK |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
500 | Internal Server Error |
Error Codes¶
See Error Codes.