Querying Credentials That Can Be Bound to a Credential Quota

Function

This API is used to query the credentials that can be bound to a credential quota. Fuzzy search by credential name is supported.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/app-quotas/{app_quota_id}/bindable-apps

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.
app_quota_id	Yes	String	Credential Quota ID

Table 2 Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Long	Offset from which the query starts. If the value is less than 0, it is automatically converted to 0. Default: 0
limit	No	Integer	Number of items displayed on each page. A value less than or equal to 0 will be automatically converted to 20, and a value greater than 500 will be automatically converted to 500. Minimum: 1 Maximum: 500 Default: 20
app_name	No	String	App name.

Request Parameters

Table 3 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.

Response Parameters

Status code: 200

Table 4 Response body parameters
Parameter	Type	Description
size	Integer	Length of the returned resource list.
total	Long	Number of resources that match the query conditions.
apps	Array of AppQuotaAppInfo objects	Credentials.

Table 5 AppQuotaAppInfo
Parameter	Type	Description
app_id	String	Credential ID.
name	String	Credential name.
status	Integer	Credential status: 1: enabled 2: disabled
app_key	String	Credential key.
remark	String	Credential description.
register_time	String	Creation time.
update_time	String	Update time.
app_quota_id	String	Credential quota ID.
app_quota_name	String	Quota name. Enter 3 to 255 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.
bound_time	String	Binding time.

Status code: 400

Table 6 Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 401

Table 7 Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 403

Table 8 Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 404

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

Status code: 500

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

Example Requests

None

Example Responses

Status code: 200

{
  "total" : 1,
  "size" : 1,
  "apps" : [ {
    "app_id" : "ac18a23f-8f06-40ac-8093-f790de2ba95b",
    "app_key" : "ac18a23f-8f06-40ac-8093-f790de2ba95b",
    "bound_time" : "0001-01-01T00:00:00Z",
    "name" : "app-test",
    "register_time" : "2020-08-22T07:57:01Z",
    "status" : 1,
    "update_time" : "2020-08-22T07:57:01Z"
  } ]
}

Status code: 400

Bad Request

{
  "error_code" : "APIG.2012",
  "error_msg" : "Invalid parameter value,parameterName:instance_id. 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.3093",
  "error_msg" : "The App quota c900c5612dbe451bb43cbcc49cfaf2f3 does not exist"
}

Status code: 500

Internal Server Error

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

Status Codes

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

Error Codes

See Error Codes.

Parent topic: Credential Quota Management

Предыдущая статья

Unbinding a Credential Quota from a Credential

Следующая статья

Asynchronous Task Management

Была ли эта статья полезна?

Поддержка Юридические документы