Updating Basic Information of an Extension
Function
This API is used to update basic information of an extension.
Calling Method
For details, see Calling APIs.
URI
POST /v1/{domain_id}/agent-plugin/update-info
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
domain_id |
Yes |
String |
Definition: Tenant ID. Constraints: N/A Value range: The value consists of 32 characters, including digits and letters. Default value: N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition: User token. Obtain a token (the value of the X-Subject-Token response header) by calling the IAM API forobtaining a user token. Constraints: N/A Value range: N/A Default value: N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
unique_id |
No |
String |
Definition: Extension UUID. Constraints: N/A Value range: The value consists of 32 characters, including digits and letters. Default value: N/A |
icon_url |
No |
String |
Definition: Extension icon URL. Constraints: N/A Value range: N/A Default value: N/A |
runtime_attribution |
No |
String |
Definition: Running attribute. Constraints: N/A Value range:
Default value: N/A |
plugin_name |
Yes |
String |
Definition: Unique identifier of the extension. Constraints: N/A Value range: N/A Default value: N/A |
display_name |
Yes |
String |
Definition: Displayed extension name. Constraints: N/A Value range: N/A Default value: N/A |
business_type |
Yes |
String |
Definition: Extension service type. Constraints: N/A Value range: N/A Default value: N/A |
business_type_display_name |
Yes |
String |
Definition: Displayed service type of the extension. Constraints: N/A Value range: N/A Default value: N/A |
description |
No |
String |
Definition: Extension description. Constraints: N/A Value range: N/A Default value: N/A |
is_private |
No |
Integer |
Definition: Whether the extension is private. Constraints: N/A Value range: N/A Default value: N/A |
region |
No |
String |
Definition: Region. Constraints: N/A Value range: N/A Default value: N/A |
maintainers |
No |
String |
Definition: Maintainer. Constraints: N/A Value range: N/A Default value: N/A |
plugin_composition_type |
No |
String |
Definition: Whether a group consists of multiple steps. Constraints: N/A Value range:
Default value: N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
- |
Boolean |
Definition: Whether the calling is successful. Value range:
|
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Parameter description: Error message. Value range: N/A |
error_code |
String |
Parameter description: Error code. Value range: N/A |
Example Requests
POST https://{endpoint}/v1/ce8df55870164338a72d7e828a966a2a/agent-plugin/update-info { "plugin_name" : "apie_test", "display_name" : "apie_test", "business_type" : "Normal", "description" : "1111", "maintainers" : "", "business_type_display_name" : "General", "icon_url" : "" }
Example Responses
Status code: 200
OK
true
SDK Sample Code
The SDK sample code is as follows.
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 49 50 51 52 53 54 55 |
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.codeartspipeline.v2.region.CodeArtsPipelineRegion; import com.huaweicloud.sdk.codeartspipeline.v2.*; import com.huaweicloud.sdk.codeartspipeline.v2.model.*; public class UpdatePluginBaseInfoSolution { 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); CodeArtsPipelineClient client = CodeArtsPipelineClient.newBuilder() .withCredential(auth) .withRegion(CodeArtsPipelineRegion.valueOf("<YOUR REGION>")) .build(); UpdatePluginBaseInfoRequest request = new UpdatePluginBaseInfoRequest(); request.withDomainId("{domain_id}"); PluginBasicDTO body = new PluginBasicDTO(); body.withMaintainers(""); body.withDescription("1111"); body.withBusinessTypeDisplayName("General"); body.withBusinessType("Normal"); body.withDisplayName("apie_test"); body.withPluginName("apie_test"); body.withIconUrl(""); request.withBody(body); try { UpdatePluginBaseInfoResponse response = client.updatePluginBaseInfo(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()); } } } |
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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcodeartspipeline.v2.region.codeartspipeline_region import CodeArtsPipelineRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcodeartspipeline.v2 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 = CodeArtsPipelineClient.new_builder() \ .with_credentials(credentials) \ .with_region(CodeArtsPipelineRegion.value_of("<YOUR REGION>")) \ .build() try: request = UpdatePluginBaseInfoRequest() request.domain_id = "{domain_id}" request.body = PluginBasicDTO( maintainers="", description="1111", business_type_display_name="General", business_type="Normal", display_name="apie_test", plugin_name="apie_test", icon_url="" ) response = client.update_plugin_base_info(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
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 main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" codeartspipeline "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartspipeline/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartspipeline/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartspipeline/v2/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 := codeartspipeline.NewCodeArtsPipelineClient( codeartspipeline.CodeArtsPipelineClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.UpdatePluginBaseInfoRequest{} request.DomainId = "{domain_id}" maintainersPluginBasicDto:= "" descriptionPluginBasicDto:= "1111" iconUrlPluginBasicDto:= "" request.Body = &model.PluginBasicDto{ Maintainers: &maintainersPluginBasicDto, Description: &descriptionPluginBasicDto, BusinessTypeDisplayName: "General", BusinessType: "Normal", DisplayName: "apie_test", PluginName: "apie_test", IconUrl: &iconUrlPluginBasicDto, } response, err := client.UpdatePluginBaseInfo(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 |
OK |
400 |
Bad request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
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