Help Center/ ROMA Connect/ API Reference/ Service Integration APIs/ Binding Signature Keys/ Querying APIs Bound with a Signature Key
Updated on 2025-10-22 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying APIs Bound with a Signature Key

Function

This API is used to query the APIs to which a signature key has been bound.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

GET /v2/{project_id}/apic/instances/{instance_id}/sign-bindings/binded-apis

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Appendix > Obtaining a Project ID in the ROMA Connect API Reference.

instance_id

Yes

String

Instance ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Long

Offset from which the query starts. If the offset is less than 0, the value is automatically converted to 0.

limit

No

Integer

Number of items displayed on each page.

sign_id

Yes

String

Signature key ID.

env_id

No

String

Environment ID.

api_id

No

String

API ID.

api_name

No

String

API name.

group_id

No

String

API group ID.

tags

No

String

API tag. Multiple API tags can be specified. The relationship between multiple parameter values is OR. If this parameter is not specified, no filtering tag is specified. If this parameter is set to #no_tags#, APIs without tags are filtered.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

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.

bindings

Array of SignApiBindingBase objects

List of signature key binding records.
Table 5 SignApiBindingBase

Parameter

Type

Description

publish_id

String

API publication ID.

api_id

String

API ID.

group_name

String

API group name.

binding_time

String

Time when the policy is bound to the API.

env_id

String

ID of the environment in which the API was published.

env_name

String

Name of the environment in which the API was published.

api_type

Integer

API type.

api_name

String

API name.

id

String

Binding record ID.

api_remark

String

API description.

sign_id

String

Signature key ID.

sign_name

String

Signature key name, The value contains 3 to 64 characters, including letters, digits, and underscores (_). It must start with a letter.

tags

Array of strings

Tags bound to the API. The default quota is 10. You can contact technical support to adjust the quota.

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

OK

{
  "total" : 1,
  "size" : 1,
  "bindings" : [ {
    "publish_id" : "40e7162dc6b94bbbbb1a60d2a24b1b0c",
    "api_id" : "5f918d104dc84480a75166ba99efff21",
    "group_name" : "api_group_001",
    "binding_time" : "2020-08-03T04:00:11Z",
    "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
    "env_name" : "RELEASE",
    "api_type" : 1,
    "api_name" : "Api_http",
    "id" : "25082bd52f74442bb1d273993d567938",
    "api_remark" : "Web backend Api",
    "sign_id" : "1885a4864bf4404283b6772fe339c249",
    "sign_name" : "signature_demo"
  } ]
}

Status code: 400

Bad Request

{
  "error_code" : "APIG.2012",
  "error_msg" : "Invalid parameter value,parameterName:api_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.3017",
  "error_msg" : "Signature key 0b0e8f456b8742218af75f945307173c 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: Binding Signature Keys