このページは、お客様の言語ではご利用いただけません。Huawei Cloudは、より多くの言語バージョンを追加するために懸命に取り組んでいます。ご協力ありがとうございました。

Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Situation Awareness
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
Software Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive

Creating a Signature Key

Updated on 2023-06-29 GMT+08:00

Function

To ensure API security, tenants are advised to provide a protection mechanism for API access. That is, for APIs exposed by tenants, the request sources must be authenticated. Requests that do not meet the authentication requirements will be rejected. The signature key is one of the API security protection mechanisms. A tenant creates a signature key and binds it to an API. When requesting the API, APIC uses the bound signature key to encrypt the request parameters and generate a signature. When a tenant's backend service receives a request, it verifies the signature. If the signature verification fails, the request is not sent by APIC. In this case, the tenant can reject the request to ensure API security and prevent the API from being attacked by requests from unknown sources.

URI

POST /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.

Request Parameters

Table 2 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).

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Signature key name. The value can contain only letters, digits, and underscores(_) and must start with a letter.

Minimum: 3

Maximum: 64

sign_type

No

String

Signature key type.

  • hmac

  • basic

  • public_key

  • aes

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.

The aes 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.

sign_key

No

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.

  • aes signature key: The value supports letters, digits, underscores (_), hyphens (-), exclamation marks (!), at signs (@), number signs (#), dollar signs ($), percent signs (%), plus signs (+), slashes (/), and equal signs (=). The value must start with a letter, digit, plus sign (+), or slash (/). If the signature algorithm is aes-128-cfb, the value is 16 characters. If the signature algorithm is aes-256-cfb, the value is 32 characters. A key is automatically generated by the backend if no key is specified.

sign_secret

No

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 key is automatically generated by the backend if no key 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 key is automatically generated by the backend if no key 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 key is automatically generated by the backend if no key is specified.

  • Vector of the AES signature secret: The value contains up to 16 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 key is automatically generated by the backend if no key is specified.

sign_algorithm

No

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.

Response Parameters

Status code: 201

Table 4 Response body parameters

Parameter

Type

Description

name

String

Signature key name. The value can contain only letters, digits, and underscores(_) and must start with a letter.

Minimum: 3

Maximum: 64

sign_type

String

Signature key type.

  • hmac

  • basic

  • public_key

  • aes

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.

The aes 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.

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.

  • aes signature key: The value supports letters, digits, underscores (_), hyphens (-), exclamation marks (!), at signs (@), number signs (#), dollar signs ($), percent signs (%), plus signs (+), slashes (/), and equal signs (=). The value must start with a letter, digit, plus sign (+), or slash (/). If the signature algorithm is aes-128-cfb, the value is 16 characters. If the signature algorithm is aes-256-cfb, the value is 32 characters. 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 key is automatically generated by the backend if no key 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 key is automatically generated by the backend if no key 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 key is automatically generated by the backend if no key is specified.

  • Vector of the AES signature secret: The value contains up to 16 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 key is automatically generated by the backend if no key is specified.

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.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

{
  "name" : "signature_demo",
  "sign_key" : "signkeysignkey",
  "sign_secret" : "signsecretsignsecretsignsecretsignsecret"
}

Example Responses

Status code: 201

Created

{
  "sign_secret" : "signsecretsignsecretsignsecretsignsecret",
  "update_time" : "2020-08-03T03:39:38.119032888Z",
  "create_time" : "2020-08-03T03:39:38.119032659Z",
  "name" : "signature_demo",
  "id" : "0b0e8f456b8742218af75f945307173c",
  "sign_key" : "signkeysignkey",
  "sign_type" : "hmac"
}

Status code: 400

Bad Request

{
  "error_code" : "APIG.2011",
  "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

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback