cloud-services kafka-server-profile¶

configure kafka server profile

kafka-server-profile Specification¶

Parameter Value

Type Configuration Resource

Element Name kafka-server-profile

Element URI /axapi/v3/cloud-services/kafka-server-profile

Element Attributes kafka-server-profile_attributes

Partition Visibility shared

Operational Data URI /axapi/v3/cloud-services/kafka-server-profile/oper

Schema kafka-server-profile schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/cloud-services/kafka-server-profile	kafka-server-profile attributes
POST /axapi/v3/cloud-services/kafka-server-profile Payload: { "kafka-server-profile": { "security_protocol": "a" } }
Get Object	GET	/axapi/v3/cloud-services/kafka-server-profile	kafka-server-profile attributes
GET /axapi/v3/cloud-services/kafka-server-profile Reponse: { "kafka-server-profile": { "security_protocol": "a", "uuid": "54800a2e-50f3-11ee-a47e-3b140db7f68c", "a10-url": "/axapi/v3/cloud-services/kafka-server-profile" } }
Modify Object	POST	/axapi/v3/cloud-services/kafka-server-profile	kafka-server-profile attributes
Replace Object	PUT	/axapi/v3/cloud-services/kafka-server-profile	kafka-server-profile attributes
PUT /axapi/v3/cloud-services/kafka-server-profile Payload: { "kafka-server-profile": { "security_protocol": "abcd" } }
Delete Object	DELETE	/axapi/v3/cloud-services/kafka-server-profile	kafka-server-profile attributes
DELETE /axapi/v3/cloud-services/kafka-server-profile Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

kafka-server-profile attributes¶

action

Description ‘register’: Register the device to the cloud; ‘deregister’: Deregister the device from the cloud;

Type: string

Supported Values: register, deregister

active_ns

Description Set active_ns in cloud credentials file

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

alias_ns

Description Set active_ns in cloud credentials file

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

bootstrap_servers

Description Set bootstrap_servers in cloud credentials file

Type: string

Format: password

Maximum Length: 63 characters

Maximum Length: 1 characters

client_id

Description Set client_id in cloud credentials file

Type: string

Format: password

Maximum Length: 63 characters

Maximum Length: 1 characters

client_secret

Description Set client_secret in cloud credentials file

Type: string

Format: password

Maximum Length: 63 characters

Maximum Length: 1 characters

primary_ns

Description Set active_ns in cloud credentials file

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

resource_group

Description Set resource_group in cloud credentials file

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

sasl_mechanisms

Description Set sasl_mechanisms in cloud credentials file

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

sasl_password

Description Set sasl_password in cloud credentials file

Type: string

Format: password

Maximum Length: 256 characters

Maximum Length: 1 characters

schema_group_name

Description Set schema_group_name in cloud credentials file

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

secondary_ns

Description Set active_ns in cloud credentials file

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

security_protocol

Description Set security_protocol in cloud credentials file

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

subscription_id

Description Set subscription_id in cloud credentials file

Type: string

Format: password

Maximum Length: 63 characters

Maximum Length: 1 characters

tenant_id

Description Set tenant_id in cloud credentials file

Type: string

Format: password

Maximum Length: 63 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters