Help Center/ ROMA Connect/ API Reference (ME-Abu Dhabi Region)/ APIC APIs/ Signature Key Management/ Querying Signature Keys

Updated on 2022-12-05 GMT+08:00

View PDF

Querying Signature Keys

Function

This API is used to query all the signature keys.

URI

GET /v2/{project_id}/apic/instances/{instance_id}/signs

**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. Default: 0
limit	No	Integer	Number of items displayed on each page. Minimum: 1 Maximum: 500 Default: 20
id	No	String	Signature key ID.
name	No	String	Signature key name.
precise_search	No	String	Parameter name (name) for exact matching.

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.
signs	Array of SignatureWithBindNum objects	Signature key list.

**Table 5** SignatureWithBindNum
Parameter	Type	Description
name	String	Signature key name. The value can contain only letters, digits, and underscores(_) and must start with a letter. NOTE: Characters must be in UTF-8 or Unicode format. Minimum: 3 Maximum: 64
sign_type	String	Signature key type. hmac basic public_key The basic key type requires the instance to be upgraded to the corresponding version. If the basic key configuration does not exist in the instance, contact technical support to upgrade the instance. The public_key type can be used only when public_key is enabled for the instance. For details about the instance feature configuration, see Appendix > APIC Features Supported by ROMA Connect Instances in the API Reference. If the public_key configuration does not exist in the instance, contact technical support to enable public_key.
sign_key	String	Signature key. hmac signature key: The value contains 8 to 32 characters, including letters, digits, underscores (_), and hyphens (-). The value must start with a letter or digit. A key is automatically generated by the backend if no key is specified. basic signature key: The value contains 4 to 32 characters, including letters, digits, underscores (_), and hyphens (-). The value must start with a letter or digit. A key is automatically generated by the backend if no key is specified. public_key signature key: The value contains 8 to 512 characters, including letters, digits, underscores (_), hyphens (-), plus signs (+), slashes (/), and equal signs (=). The value must start with a letter, digit, plus sign (+), or slash (/). A key is automatically generated by the backend if no key is specified.
sign_secret	String	Signature secret. hmac signature secret: The value contains 16 to 64 characters, including letters, digits, underscores (_), hyphens (-), exclamation marks (!), at signs (@), number signs (#), dollar signs ($), and percent signs (%). The value must start with a letter or digit. A secret is automatically generated by the backend if no secret is specified. basic signature secret: The value contains 8 to 64 characters, including letters, digits, underscores (_), hyphens (-), exclamation marks (!), at signs (@), number signs (#), dollar signs ($), and percent signs (%). The value must start with a letter or digit. A secret is automatically generated by the backend if no secret is specified. public_key signature secret: The value contains 15 to 2048 characters, including letters, digits, underscores (_), hyphens (-), exclamation marks (!), at signs (@), number signs (#), dollar signs ($), percent signs (%), plus signs (+), slashes (/), and equal signs (=). The value must with a letter, digit, plus sign (+), or slash (/). A secret is automatically generated by the backend if no secret is specified.
update_time	String	Update time.
create_time	String	Creation time.
id	String	Signature key ID.
bind_num	Integer	Number of bound APIs.
ldapi_bind_num	Integer	Number of bound custom backends.

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" : 2,
  "size" : 2,
  "signs" : [ {
    "sign_secret" : "signsecretsignsecretsignsecretsignsecret",
    "update_time" : "2018-02-07T02:00:27.964766Z",
    "create_time" : "2018-02-06T12:17:36Z",
    "name" : "signature_demo",
    "id" : "0b0e8f456b8742218af75f945307173c",
    "sign_key" : "signkeysignkey",
    "sign_type" : "hmac",
    "bind_num" : 0,
    "ldapi_bind_num" : 0
  }, {
    "sign_secret" : "9ce16b029034464898ee33540c42e16a",
    "update_time" : "2020-07-30T03:56:58Z",
    "create_time" : "2020-07-30T03:56:58Z",
    "name" : "Signature_udlu",
    "id" : "9dc388382fba485aadd19f932303f4c9",
    "sign_key" : "ca50c5b670044c83b5b890a9a68a30d5",
    "sign_type" : "hmac",
    "bind_num" : 0,
    "ldapi_bind_num" : 0
  } ]
}

Status code: 400

Bad Request

{
  "error_code" : "APIG.2012",
  "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.3030",
  "error_msg" : "The instance does not exist;id:f0fa1789-3b76-433b-a787-9892951c620ec"
}

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: Signature Key Management

Previous topic: Deleting a Signature Key

Next topic: Binding/Unbinding Signature Keys

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