更新时间:2024-10-31 GMT+08:00
分享

新建服务成员

功能介绍

批量添加服务组成员

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/service-items

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID, 可以从调API处获取,也可以从控制台获取。项目ID获取方式

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

企业项目ID,用户根据组织规划企业项目,对应的ID为企业项目ID,可通过如何获取企业项目ID获取,用户未开启企业项目时为0

fw_instance_id

String

防火墙id,可通过防火墙ID获取方式获取

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。可通过如何获取用户Token获取。

表4 请求Body参数

参数

是否必选

参数类型

描述

set_id

String

服务组id,可通过获取服务组列表接口查询获得,通过返回值中的data.records.set_id(.表示各对象之间层级的区分)获得。

service_items

Array of service_items objects

服务组成员列表

表5 service_items

参数

是否必选

参数类型

描述

protocol

Integer

协议类型:TCP为6,UDP为17,ICMP为1,ICMPV6为58,ANY为-1,手动类型不为空,自动类型为空

source_port

String

源端口

dest_port

String

目的端口

description

String

服务成员描述

响应参数

状态码: 200

表6 响应Body参数

参数

参数类型

描述

data

ServiceItemIds object

创建服务组成员返回数据

表7 ServiceItemIds

参数

参数类型

描述

items

Array of items objects

服务组成员id列表

表8 items

参数

参数类型

描述

id

String

服务组成员id

状态码: 400

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

给项目id为9d80d070b6d44942af73c9c3d38e0429的项目添加名称为ceshi的服务组成员,描述为添加服务组成员

https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/service-items

{
  "set_id" : "7cdebed3-af07-494e-a3c2-b88bb8d58b57",
  "service_items" : [ {
    "description" : "添加服务组成员",
    "dest_port" : "1",
    "source_port" : "1",
    "protocol" : 6
  } ]
}

响应示例

状态码: 200

添加服务组成员返回值

{
  "data" : {
    "items" : [ {
      "id" : "cc41c4af-86e8-4ed2-80ad-87d399aeaed0"
    } ]
  }
}

状态码: 400

Bad Request

{
  "error_code" : "CFW.00200001",
  "error_msg" : "空参数错误"
}

SDK代码示例

SDK代码示例如下。

Java

给项目id为9d80d070b6d44942af73c9c3d38e0429的项目添加名称为ceshi的服务组成员,描述为添加服务组成员

 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
56
57
58
59
60
61
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.*;

import java.util.List;
import java.util.ArrayList;

public class AddServiceItemsSolution {

    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();
        AddServiceItemsRequest request = new AddServiceItemsRequest();
        AddServiceItemsUsingPOSTRequestBody body = new AddServiceItemsUsingPOSTRequestBody();
        List<AddServiceItemsUsingPOSTRequestBodyServiceItems> listbodyServiceItems = new ArrayList<>();
        listbodyServiceItems.add(
            new AddServiceItemsUsingPOSTRequestBodyServiceItems()
                .withProtocol(6)
                .withSourcePort("1")
                .withDestPort("1")
                .withDescription("添加服务组成员")
        );
        body.withServiceItems(listbodyServiceItems);
        body.withSetId("7cdebed3-af07-494e-a3c2-b88bb8d58b57");
        request.withBody(body);
        try {
            AddServiceItemsResponse response = client.addServiceItems(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());
        }
    }
}

Python

给项目id为9d80d070b6d44942af73c9c3d38e0429的项目添加名称为ceshi的服务组成员,描述为添加服务组成员

 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
# 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 = AddServiceItemsRequest()
        listServiceItemsbody = [
            AddServiceItemsUsingPOSTRequestBodyServiceItems(
                protocol=6,
                source_port="1",
                dest_port="1",
                description="添加服务组成员"
            )
        ]
        request.body = AddServiceItemsUsingPOSTRequestBody(
            service_items=listServiceItemsbody,
            set_id="7cdebed3-af07-494e-a3c2-b88bb8d58b57"
        )
        response = client.add_service_items(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

给项目id为9d80d070b6d44942af73c9c3d38e0429的项目添加名称为ceshi的服务组成员,描述为添加服务组成员

 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
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.AddServiceItemsRequest{}
	descriptionServiceItems:= "添加服务组成员"
	var listServiceItemsbody = []model.AddServiceItemsUsingPostRequestBodyServiceItems{
        {
            Protocol: int32(6),
            SourcePort: "1",
            DestPort: "1",
            Description: &descriptionServiceItems,
        },
    }
	request.Body = &model.AddServiceItemsUsingPostRequestBody{
		ServiceItems: listServiceItemsbody,
		SetId: "7cdebed3-af07-494e-a3c2-b88bb8d58b57",
	}
	response, err := client.AddServiceItems(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

添加服务组成员返回值

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码

相关文档