更新对象配置描述
功能介绍
更新对象配置描述
调用方法
请参见如何调用API。
URI
PUT /v1/{project_id}/config/object/description
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,可以从调API处获取,也可以从控制台获取。项目ID获取方式 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。可通过如何获取用户Token获取。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
description |
否 |
String |
成员描述 |
fw_instance_id |
否 |
String |
防火墙ID,可通过防火墙ID获取方式获取 |
item_id |
否 |
String |
成员id,地址组成员id,可通过查询地址组成员接口查询获得,通过返回值中的data.records.item_id(.表示各对象之间层级的区分)获得。服务组成员id,可通过查询服务成员列表接口查询获得,通过返回值中的data.records.item_id(.表示各对象之间层级的区分)获得。域名id可通过获取域名组下域名列表接口查询获得,通过返回值中的data.records.domain_address_id(.表示各对象之间层级的区分)获得。 |
set_id |
否 |
String |
组id,地址组id,可通过查询地址组列表接口查询获得,通过返回值中的data.records.set_id(.表示各对象之间层级的区分)获得。服务组id,可通过获取服务组列表接口查询获得,通过返回值中的data.records.set_id(.表示各对象之间层级的区分)获得。域名组id,可通过查询域名组列表接口查询获得,通过返回值中的data.records.set_id(.表示各对象之间层级的区分)获得。 |
type |
否 |
String |
组类型,包含:地址组ADDR_SET,服务组SERV_SET,域名组DOMAIN_SET,URL组URL_SET |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
data |
String |
成员id |
请求示例
更新项目id为408972e72dcd4c1a9b033e955802a36b下的地址组成员描述,防火墙ID为b273e6c6-59f3-44cc-9a0d-89824814b474,地址组id为4fc0f061-3f3f-4a16-821c-30d7f6fb895d,地址组成员id为0eac72c9-da3e-4386-b2f2-eb7dbc37d25f,描述为test
https://{Endpoint}/v1/408972e72dcd4c1a9b033e955802a36b/config/object/description { "set_id" : "4fc0f061-3f3f-4a16-821c-30d7f6fb895d", "type" : "ADDR_SET", "item_id" : "0eac72c9-da3e-4386-b2f2-eb7dbc37d25f", "description" : "test", "fw_instance_id" : "b273e6c6-59f3-44cc-9a0d-89824814b474" }
响应示例
状态码:200
更新对象配置描述返回值
{ "data" : "0eac72c9-da3e-4386-b2f2-eb7dbc37d25f" }
SDK代码示例
SDK代码示例如下。
更新项目id为408972e72dcd4c1a9b033e955802a36b下的地址组成员描述,防火墙ID为b273e6c6-59f3-44cc-9a0d-89824814b474,地址组id为4fc0f061-3f3f-4a16-821c-30d7f6fb895d,地址组成员id为0eac72c9-da3e-4386-b2f2-eb7dbc37d25f,描述为test
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 |
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.cfw.v1.region.CfwRegion; import com.huaweicloud.sdk.cfw.v1.*; import com.huaweicloud.sdk.cfw.v1.model.*; public class UpdateObjectConfigDescSolution { 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"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); CfwClient client = CfwClient.newBuilder() .withCredential(auth) .withRegion(CfwRegion.valueOf("<YOUR REGION>")) .build(); UpdateObjectConfigDescRequest request = new UpdateObjectConfigDescRequest(); ObjectInfoDto body = new ObjectInfoDto(); body.withType("ADDR_SET"); body.withSetId("4fc0f061-3f3f-4a16-821c-30d7f6fb895d"); body.withItemId("0eac72c9-da3e-4386-b2f2-eb7dbc37d25f"); body.withFwInstanceId("b273e6c6-59f3-44cc-9a0d-89824814b474"); body.withDescription("test"); request.withBody(body); try { UpdateObjectConfigDescResponse response = client.updateObjectConfigDesc(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()); } } } |
更新项目id为408972e72dcd4c1a9b033e955802a36b下的地址组成员描述,防火墙ID为b273e6c6-59f3-44cc-9a0d-89824814b474,地址组id为4fc0f061-3f3f-4a16-821c-30d7f6fb895d,地址组成员id为0eac72c9-da3e-4386-b2f2-eb7dbc37d25f,描述为test
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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcfw.v1.region.cfw_region import CfwRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcfw.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"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = CfwClient.new_builder() \ .with_credentials(credentials) \ .with_region(CfwRegion.value_of("<YOUR REGION>")) \ .build() try: request = UpdateObjectConfigDescRequest() request.body = ObjectInfoDto( type="ADDR_SET", set_id="4fc0f061-3f3f-4a16-821c-30d7f6fb895d", item_id="0eac72c9-da3e-4386-b2f2-eb7dbc37d25f", fw_instance_id="b273e6c6-59f3-44cc-9a0d-89824814b474", description="test" ) response = client.update_object_config_desc(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
更新项目id为408972e72dcd4c1a9b033e955802a36b下的地址组成员描述,防火墙ID为b273e6c6-59f3-44cc-9a0d-89824814b474,地址组id为4fc0f061-3f3f-4a16-821c-30d7f6fb895d,地址组成员id为0eac72c9-da3e-4386-b2f2-eb7dbc37d25f,描述为test
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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" cfw "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/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") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := cfw.NewCfwClient( cfw.CfwClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.UpdateObjectConfigDescRequest{} request.Body = &model.ObjectInfoDto{ Type: "ADDR_SET", SetId: "4fc0f061-3f3f-4a16-821c-30d7f6fb895d", ItemId: "0eac72c9-da3e-4386-b2f2-eb7dbc37d25f", FwInstanceId: "b273e6c6-59f3-44cc-9a0d-89824814b474", Description: "test", } response, err := client.UpdateObjectConfigDesc(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
更新对象配置描述返回值 |
错误码
请参见错误码。