Querying Signature Keys
Function
This API is used to query all the signature keys.
URI
GET /v2/{project_id}/apic/instances/{instance_id}/signs
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. |
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. |
id |
No |
String |
Signature key ID. |
name |
No |
String |
Signature key name. |
precise_search |
No |
String |
Parameter name for exact matching. If multiple parameters need to support exact match, separate them with commas (,). Currently, only name is supported. |
Request 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
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. |
Parameter |
Type |
Description |
---|---|---|
name |
String |
Signature key name. The value can contain only letters, digits, and underscores(_) and must start with a letter. |
sign_type |
String |
Signature key type:
To use a Basic or AES signature key, ensure that your instance version supports it. If your instance does not support this type of signature key, contact technical support to upgrade your instance. To use a public_key signature key, ensure that the public_key feature has been configured for your instance. For details, see "Appendix" > "Supported Features". If your instance does not support this feature, contact technical support to enable it. |
sign_key |
String |
Signature key.
|
sign_secret |
String |
Signature secret.
|
sign_algorithm |
String |
Signature algorithm. The default value is empty. Only AES signature keys support the signature algorithm. Other signature keys do not support the signature algorithm. |
update_time |
String |
Update time. |
create_time |
String |
Creation time. |
id |
String |
Signature key ID. |
bind_num |
Integer |
Number of APIs bound. |
ldapi_bind_num |
Integer |
Number of custom backends bound. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Example Requests
None
Example Responses
Status code: 200
OK
{ "total" : 2, "size" : 2, "signs" : [ { "sign_secret" : "sig**********ret", "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" : "9ce**********16a", "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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot