addressgroup

type AddGroupMemberOpts struct {
	// Address group ID
	SetId string `json:"set_id,omitempty"`
	// Address group member list.
	AddressItems []AddressItem `json:"address_items,omitempty"`
}

type AddGroupMemberResponse struct {
	Data AddressItemsResponse `json:"data"`
}

type AddressGroupData struct {
	ID             string `json:"id"`
	Name           string `json:"name"`
	Description    string `json:"description"`
	AddressSetType int    `json:"address_set_type"`
	AddressType    int    `json:"address_type"`
}

type AddressGroupMembersData struct {
	// Number of records displayed on each page. The value ranges from 1 to 1024.
	Limit int `json:"limit"`
	// Offset, which specifies the start position of the record to be returned.
	Offset int `json:"offset"`
	// Query the total number of blacklist/whitelist records.
	Total int `json:"total"`
	// Address Group ID.
	SetId string `json:"set_id"`
	// The list of Blacklist/Whitelist records
	Records []GroupMemberRecord `json:"records"`
}

type AddressGroupRecord struct {
	// Address group ID.
	SetID string `json:"set_id"`
	// Number of times an address group is referenced by rules.
	RefCount int `json:"ref_count"`
	// Description.
	Description string `json:"description"`
	// Internet protocol type of an address: 0 (IPv4), 1 (IPv6).
	AddressType int `json:"address_type"`
	// Protected object ID, used to distinguish between Internet border protection and VPC border protection.
	ObjectID string `json:"object_id"`
	// Address group type:
	// 0 - User-defined address group
	// 1 - WAF back-to-source IP address group
	// 2 - DDoS back-to-source IP address group
	// 3 - NAT64 address group
	AddressSetType int `json:"address_set_type"`
}

type AddressGroupsData struct {
	// Number of records displayed on each page. The value ranges from 1 to 1024.
	Limit int `json:"limit"`
	// Offset, which specifies the start position of the record to be returned.
	Offset int `json:"offset"`
	// Query the total number of address group records.
	Total int `json:"total"`
	// The list of address group records
	Records []AddressGroupRecord `json:"records"`
}

type AddressItem struct {
	// Internet protocol type of an address: 0 (IPv4), 1 (IPv6).
	AddressType *int `json:"address_type,omitempty"`
	// IP address.
	Address string `json:"address" required:"true"`
	// Description.
	Description string `json:"description,omitempty"`
}

type AddressItemId struct {
	// ID of an address group member.
	Id string `json:"id"`
}

type AddressItemsResponse struct {
	// List of address group member IDs.
	Items []AddressItemId `json:"items"`
	// List of covered IP addresses.
	CoveredIp []CoveredIPVO `json:"covered_ip"`
}

type AddressSetId struct {
	// Address group ID.
	Id string `json:"id"`
	// IP address group name.
	Name string `json:"name"`
}

type CoveredIPVO struct {
	// IP address
	IP string `json:"ip"`
	// Cover an IP address.
	CoveredIP string `json:"covered_Ip"`
}

type CreateOpts struct {
	// Protected object ID, which is used to distinguish between Internet border protection and VPC border protection
	// after a cloud firewall is created. You can obtain the ID by calling the Get function in management package.
	// In the return value, find the ID in ProtectObjects[n].ObjectID.
	// If the value of type is 0, the protected object ID belongs to the Internet border.
	// If the value of type is 1, the protected object ID belongs to the VPC border.
	ObjectID string `json:"object_id" required:"true"`
	// IP address group name.
	Name string `json:"name" required:"true"`
	// Description.
	Description string `json:"description,omitempty"`
	// Internet protocol type of an address: 0 (IPv4), 1 (IPv6).
	AddressType *int `json:"address_type,omitempty"`
}

type CreateResponse struct {
	Data AddressSetId `json:"data"`
}

type GetGroupMemberQueryParameters struct {
	// Address group ID. It is the same as ID retuned while creating an address group.
	SetID string `q:"set_id" required:"true"`
	// Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is 0.
	Offset string `q:"offset" required:"true"`
	// Number of records displayed on each page. The value ranges from 1 to 1024.
	Limit int `q:"limit" required:"true"`
	// IP address.
	Address string `q:"address,omitempty"`
}

type GetGroupMembersResponse struct {
	// Returned data for querying address group members.
	Data AddressGroupMembersData `json:"data"`
}

type GetResponse struct {
	Data AddressGroupData `json:"data"`
}

type GroupMemberRecord struct {
	// ID of an address group member.
	ItemID string `json:"item_id"`
	// Name of an address group member.
	Name string `json:"name"`
	// Internet protocol type of an address: 0 (IPv4), 1 (IPv6).
	AddressType int `json:"address_type"`
	// IP address.
	Address string `json:"address"`
	// Description.
	Description string `json:"description"`
}

type ListQueryParameters struct {
	// Protected object ID, which is used to distinguish between Internet border protection and VPC border protection
	// after a cloud firewall is created. You can obtain the ID by calling the Get function in management package.
	// In the return value, find the ID in ProtectObjects[n].ObjectID.
	// If the value of type is 0, the protected object ID belongs to the Internet border.
	// If the value of type is 1, the protected object ID belongs to the VPC border.
	ObjectID string `q:"object_id" required:"true"`
	// Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is 0.
	Offset string `q:"offset" required:"true"`
	// Number of records displayed on each page. The value ranges from 1 to 1024.
	Limit int `q:"limit" required:"true"`
}

type ListResponse struct {
	// Returned data for querying the address group list.
	Data AddressGroupsData `json:"data"`
}

type UpdateOpts struct {
	// IP address group name.
	Name string `json:"name,omitempty"`
	// Description.
	Description string `json:"description,omitempty"`
}

type UpdateResponse struct {
	Data AddressSetId `json:"data"`
}