Creating a Service Agency
Function
Create a service agency for CSMS and FunctionGraph.
Calling Method
For details, see Calling APIs.
URI
POST /v1/csms/agencies
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
secret_type |
Yes |
String |
Secret type |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
agencies |
Array of Agency objects |
Agency details list |
Parameter |
Type |
Description |
---|---|---|
agency_name |
String |
Agency name |
agency_id |
String |
Agency ID |
error_msg |
String |
Error message. Returned error message when the agency fails to be created. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error codes |
error_msg |
String |
Error description |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error codes |
error_msg |
String |
Error description |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error codes |
error_msg |
String |
Error description |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error codes |
error_msg |
String |
Error description |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error codes |
error_msg |
String |
Error description |
Status code: 502
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error codes |
error_msg |
String |
Error description |
Status code: 504
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error codes |
error_msg |
String |
Error description |
Example Requests
Create an agency for RDS-FG secrets.
{ "secret_type" : "RDS-FG" }
Example Responses
Status code: 200
Request succeeded.
{ "agencies" : [ { "agency_name" : "xxxx1", "agency_id" : "xxxxxxx" }, { "agency_name" : "xxxxx2", "error_msg" : "xxxxxxxx" } ] }
SDK Sample Code
The SDK sample code is as follows.
Create an agency for RDS-FG secrets.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.csms.v1.region.CsmsRegion; import com.huaweicloud.sdk.csms.v1.*; import com.huaweicloud.sdk.csms.v1.model.*; public class CreateAgencySolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); CsmsClient client = CsmsClient.newBuilder() .withCredential(auth) .withRegion(CsmsRegion.valueOf("<YOUR REGION>")) .build(); CreateAgencyRequest request = new CreateAgencyRequest(); CreateAgencyRequestBody body = new CreateAgencyRequestBody(); body.withSecretType(CreateAgencyRequestBody.SecretTypeEnum.fromValue("RDS-FG")); request.withBody(body); try { CreateAgencyResponse response = client.createAgency(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Create an agency for RDS-FG secrets.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcsms.v1.region.csms_region import CsmsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcsms.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = CsmsClient.new_builder() \ .with_credentials(credentials) \ .with_region(CsmsRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateAgencyRequest() request.body = CreateAgencyRequestBody( secret_type="RDS-FG" ) response = client.create_agency(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Create an agency for RDS-FG secrets.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" csms "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/csms/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/csms/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/csms/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := csms.NewCsmsClient( csms.CsmsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreateAgencyRequest{} request.Body = &model.CreateAgencyRequestBody{ SecretType: model.GetCreateAgencyRequestBodySecretTypeEnum().RDS_FG, } response, err := client.CreateAgency(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
Request succeeded. |
400 |
Invalid request parameter. |
401 |
Username and password are required for the requested page. |
403 |
Authentication failed. |
404 |
The resource does not exist. |
500 |
Internal service error. |
502 |
Request failed. The server has received an invalid response. |
504 |
Gateway timed out. |
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